API Overview Resources Schemas

Identification Chain

Get chained identification process status

Returns the global status and step details of a chained identification process.

GET /orgs/{org_id}/identifications/chain/{identification_chain_id}

Parameters

Name	In	Type	Required	Description
org_id	path	string	true	Organization name
identification_chain_id	path	string	true	Unique identifier for the chained identification process
User-Agent	header	string	true	information to identify the application, operating system, vendor, and/or version of the requester

Request example

1
2
3
4
5



curl -X GET https://documents.masstack.com/v1/orgs/{org_id}/identifications/chain/{identification_chain_id} \
  -H "Accept: application/json" \
  -H "User-Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X x.y; rv:42.0) Gecko/20100101 Firefox/42.0"

Responses

Code	Meaning	Description	Schema
200	OK	Chained identification status found	GetChainIdentificationResponse
403	Forbidden	Forbidden. Request has invalid credentials	None
404	Not Found	Not found. Entity does not exist or can not be found	None
default	Default	Error response	ErrorsResponse

Validate chained identification process

Validates a chained identification process. If the process exists and is in CREATED state, and all nested identifications are VALIDATED, the chain transitions to VALIDATED and a short-lived x-access-token (JWT) is generated and returned in the response header. Otherwise, returns 409 Conflict if the process or any nested identification is not in the required state, or 404 Not Found if the chain does not exist.

POST /orgs/{org_id}/identifications/chain/{identification_chain_id}/validate

Parameters

Name	In	Type	Required	Description
org_id	path	string	true	Organization name
identification_chain_id	path	string	true	Unique identifier for the chained identification process
x-installation_id	header	string	true	browser installation id (unique identifier)
x-location	header	string	false	device location coordinate
x-fingerprint	header	string	true	device fingerprint
x-forwarded-for	header	string	true	Device IP address automatically collected by the backend server. Any value provided by the client will be ignored.
User-Agent	header	string	true	information to identify the application, operating system, vendor, and/or version of the requester

Request example

1
2
3
4
5
6
7
8
9



curl -X POST https://documents.masstack.com/v1/orgs/{org_id}/identifications/chain/{identification_chain_id}/validate \
  -H "Accept: application/json" \
  -H "x-installation_id: 625fc44b-5b1c-451e-bcc7-276c911f0af8" \
  -H "x-location: 88.52,-123.1" \
  -H "x-fingerprint: 33dd65c7fefc7078776965ca85cee243" \
  -H "x-forwarded-for: 88.88.88.88" \
  -H "User-Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X x.y; rv:42.0) Gecko/20100101 Firefox/42.0"

Responses

Code	Meaning	Description	Schema
204	No Content	Action executed correctly	None
400	Bad Request	Request input is not valid	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
default	Default	Error response	ErrorsResponse

Restart chained identification process.

Restores the states and metadata for a chained identification process to CREATED state so that all VALIDATED steps are invalidated and should be done again. If a step is in CREATED state, it remains unchanged. This operation can only be performed if the chained identification process is in VALIDATED or CREATED state.

POST /orgs/{org_id}/identifications/chain/{identification_chain_id}/restart

Parameters

Name	In	Type	Required	Description
org_id	path	string	true	Organization name
identification_chain_id	path	string	true	Unique identifier for the chained identification process
User-Agent	header	string	true	information to identify the application, operating system, vendor, and/or version of the requester

Request example

1
2
3
4
5



curl -X POST https://documents.masstack.com/v1/orgs/{org_id}/identifications/chain/{identification_chain_id}/restart \
  -H "Accept: application/json" \
  -H "User-Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X x.y; rv:42.0) Gecko/20100101 Firefox/42.0"

Responses

Code	Meaning	Description	Schema
204	No Content	Restoration successful. No Content returned.	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
500	Internal Server Error	Not expected error	None
default	Default	Error response	ErrorsResponse

Endpoints

Documents

Forms

Sections

Templates

Templates Configuration

DynamicTemplates

Digital Sign Process

Biometric Signature

Simple Signature

Identification Agent

Sign Configuration

Identification OTP

Identification with identity document

Identification Agent Admin

Identification OTP Admin

Identification with identity document Admin

Contracts

Scoring

Securize

Identification Chain

Identification Chain Admin