Identification OTP

Get otp identification process metadata

Get information about otp identification process

GET /orgs/{org_id}/identifications/otp/{identification_id}

Parameters

Name	In	Type	Required	Description
org_id	path	string	true	Organization name
identification_id	path	string	true	uuid for each signer’s identification process associated to a digital sign process

Request example

1
2
3
4



curl -X GET https://documents.masstack.com/v1/orgs/{org_id}/identifications/otp/{identification_id} \
  -H "Accept: application/json"

Responses

Code	Meaning	Description	Schema
200	OK	Expected response for a valid request.	GetOtpIdentificationMetadataResponse
400	Bad Request	Request input is not valid	None
401	Unauthorized	Unauthorized. AuthN and AuthZ validations have fail	None
404	Not Found	Not found. Entity does not exist or can not be found	None
500	Internal Server Error	Not expected error	None
default	Default	Error response	ErrorsResponse

OTP identification token validation

PUT /orgs/{org_id}/identifications/otp/{identification_id}/validate

Parameters

Name	In	Type	Required	Description
org_id	path	string	true	Organization name
identification_id	path	string	true	uuid for each signer’s identification process associated to a digital sign process
x-installation_id	header	string	true	browser installation id (unique identifier)
x-fingerprint	header	string	true	device fingerprint
x-location	header	string	false	device location coordinate
User-Agent	header	string	true	information to identify the application, operating system, vendor, and/or version of the requester
body	body	ValidateOtpIdentificationRequest	false	Necessary data to execute action

Request body - instance of ValidateOtpIdentificationRequest

1
2
3
4


{
  "code": "k4khb9",
  "two_factor": "12345678A"
}

Name	Type	Required	Description
code	string	true	challenge code
two_factor	TwoFactorValue	false	Value used for two factor. Will match a national id, passport number or email.

Request example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13



curl -X PUT https://documents.masstack.com/v1/orgs/{org_id}/identifications/otp/{identification_id}/validate \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "x-installation_id: 625fc44b-5b1c-451e-bcc7-276c911f0af8" \
  -H "x-fingerprint: 33dd65c7fefc7078776965ca85cee243" \
  -H "x-location: 88.52,-123.1" \
  -H "User-Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X x.y; rv:42.0) Gecko/20100101 Firefox/42.0" \
 --data-raw "{
  'code': 'k4khb9',
  'two_factor': '12345678A'
}" 

Responses

Code	Meaning	Description	Schema
204	No Content	Action executed correctly	None
400	Bad Request	Request input is not valid	None
401	Unauthorized	Unauthorized. AuthN and AuthZ validations have fail	None
403	Forbidden	Forbidden. Request has invalid credentials	None
404	Not Found	Not found. Entity does not exist or can not be found	None
409	Conflict	Conflict. Entity state has conflicts between its new state and the old one.	None
410	Gone	Gone. Resource is no longer available	None
500	Internal Server Error	Not expected error	None
default	Default	Error response	ErrorsResponse

OTP identification token challenge

PUT /orgs/{org_id}/identifications/otp/{identification_id}/challenge

Parameters

Name	In	Type	Required	Description
org_id	path	string	true	Organization name
identification_id	path	string	true	uuid for each signer’s identification process associated to a digital sign process
body	body	CreateOtpChallengeRequest	false	Necessary data to execute action

Request body - instance of CreateOtpChallengeRequest

1
2
3


{
  "two_factor": "12345678A or actor@email.com or 'iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAABbklEQVR42mNkAAYYgZ=='"
}

Name	Type	Required	Description
two_factor	TwoFactorValueOrImage	false	Value used for two factor. Value depends of two factor type: - DOCUMENT_NUMBER: Value must be actor’s personal identification id or passport number. - EMAIL: Value must be actor’s email address. - PERSONAL_DOCUMENT_IMAGE: Image in Base64 format of the document number (back and front) defined in actor’s document number field

Request example

1
2
3
4
5
6
7
8



curl -X PUT https://documents.masstack.com/v1/orgs/{org_id}/identifications/otp/{identification_id}/challenge \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
 --data-raw "{
  'two_factor': '12345678A or actor@email.com or 'iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAABbklEQVR42mNkAAYYgZ==''
}" 

Responses

Code	Meaning	Description	Schema
200	OK	Action executed correctly	TwoFactorValueResponse
204	No Content	Action executed correctly	None
400	Bad Request	Request input is not valid	None
401	Unauthorized	Unauthorized. AuthN and AuthZ validations have fail	None
403	Forbidden	Forbidden. Request has invalid credentials	None
404	Not Found	Not found. Entity does not exist or can not be found	None
409	Conflict	Conflict. Entity state has conflicts between its new state and the old one.	None
412	Precondition Failed	Precondition failed. Request can not be processed yet	None
500	Internal Server Error	Not expected error	None
default	Default	Error response	ErrorsResponse