You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Jun 4, 2025. It is now read-only.
description: File identifier. It is necessary to keep it because it must be used to update or delete a signature request and will also be used in the callback request.
934
+
status:
935
+
type: integer
936
+
enum:
937
+
- 0
938
+
- 1
939
+
- 2
940
+
description: |
941
+
Numeric code of status * 0 - no signers * 1 - signed * 2 - pending
942
+
example: 1
943
+
statusText:
944
+
type: string
945
+
description: Translated text of status
946
+
example: able to sign
947
+
request_date:
948
+
type: string
949
+
format: date-time
950
+
pattern: '\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}'
951
+
nullable: true
952
+
description: Date the file was requested to be signed
953
+
example: '2021-12-31 22:45:50'
954
+
requested_by:
955
+
$ref: '#/components/schemas/basicAccount'
956
+
settings:
957
+
$ref: '#/components/schemas/signSettings'
958
+
signers:
959
+
type: array
960
+
description: Collection of users who must sign the document
961
+
items:
962
+
type: object
963
+
description: Person who will sign
964
+
properties:
965
+
email:
966
+
type: string
967
+
format: email
968
+
description: Unique email to identify user
969
+
example: user@test.coop
970
+
me:
971
+
type: boolean
972
+
description: It's me?
973
+
example: true
974
+
sign_uuid:
975
+
type: string
976
+
format: uuid
977
+
description: 'Received from sign request, only returned when me=true'
978
+
displayName:
979
+
type: string
980
+
nullable: true
981
+
description: Persons name
982
+
example: John Doe
983
+
fullName:
984
+
type: string
985
+
description: The person full name
986
+
example: John Doe
987
+
nullable: true
988
+
signed:
989
+
type: string
990
+
pattern: '\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}'
991
+
description: 'Signing date, when signed'
992
+
example: '2021-12-31 22:45:50'
993
+
nullable: true
994
+
identifyMethods:
995
+
type: array
996
+
items:
997
+
type: object
998
+
properties:
999
+
method:
1000
+
type: string
1001
+
example: account
1002
+
description: The identify method name
1003
+
value:
1004
+
type: string
1005
+
example: signer1
1006
+
description: The value that identify the signer in the authentication method
1007
+
uid:
1008
+
type: string
1009
+
nullable: true
1010
+
description: Nextcloud user id of who requested the file to be signed when the person created account.
1011
+
example: johndoe
1012
+
description:
1013
+
type: string
1014
+
nullable: true
1015
+
description: Description that will be displayed to the person
1016
+
example: 'As the company''s CEO, you must sign this contract'
1017
+
sign_date:
1018
+
type: string
1019
+
format: date-time
1020
+
pattern: '\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}'
1021
+
nullable: true
1022
+
description: Date the file was signed
1023
+
example: '2021-12-31 22:45:50'
1024
+
identify:
1025
+
type: string
1026
+
nullable: true
1027
+
default: nextcloud
1028
+
example: nextcloud
1029
+
description: 'When is requested to a person to sign a file, is necessary identify what is the identification method. The identification method is used to define how will be the sign flow.'
1030
+
enum:
1031
+
- nextcloud
1032
+
- email-link
1033
+
- email-token
1034
+
- sms-token
1035
+
signRequestId:
1036
+
type: integer
1037
+
description: ID of relation between file and user. Each relation between file and user has an ID that is returned on validation endpoints.
0 commit comments