API Overview Resources Schemas

Identification Chain Admin

Create a chained identification process.

Creates a new chained identification process with a ordered sequence of identification steps (at least one, without repeated elements).

POST /orgs/{org_id}/identifications/chain

Parameters

Name	In	Type	Required	Description
org_id	path	string	true	Organization name
User-Agent	header	string	true	information to identify the application, operating system, vendor, and/or version of the requester
body	body	CreateChainIdentificationRequest	true	Data about actor and the identification chain process.

Request body - instance of CreateChainIdentificationRequest

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39


{
  "actor": {
    "name": "James",
    "last_name": "Smith",
    "identity_document": {
      "document_number": "12345678A",
      "document_type": "IDENTITY_CARD",
      "country": "ES"
    },
    "email": "example@email.com",
    "msisdn": {
      "phone_number": 6123456789,
      "country_code": "34"
    },
    "language": "ES"
  },
  "expires_in": "PT15M",
  "sequence": [
    {
      "identification_type": "OTP",
      "otp_step": {
        "two_factor_type": "DOCUMENT_NUMBER",
        "channel": {
          "type": "SMS",
          "external": false
        }
      }
    },
    {
      "identification_type": "AGENT"
    },
    {
      "identification_type": "IDENTITY_DOCUMENT",
      "identity_document_step": {
        "provider_type": "INTERNAL"
      }
    }
  ]
}

Name	Type	Required	Description
actor	IdentificationActorChain	true	none
expires_in	string	true	Validity duration time (ISO-8601 format) from now.
sequence	[ChainIdentificationStep]	true	Ordered array defining the identification steps (each step should be unique).

Request example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45



curl -X POST https://documents.masstack.com/v1/orgs/{org_id}/identifications/chain \
  -H "Content-Type: application/json" \
  -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" \
 --data-raw "{
  'actor': {
    'name': 'James',
    'last_name': 'Smith',
    'identity_document': {
      'document_number': '12345678A',
      'document_type': 'IDENTITY_CARD',
      'country': 'ES'
    },
    'email': 'example@email.com',
    'msisdn': {
      'phone_number': 6123456789,
      'country_code': '34'
    },
    'language': 'ES'
  },
  'expires_in': 'PT15M',
  'sequence': [
    {
      'identification_type': 'OTP',
      'otp_step': {
        'two_factor_type': 'DOCUMENT_NUMBER',
        'channel': {
          'type': 'SMS',
          'external': false
        }
      }
    },
    {
      'identification_type': 'AGENT'
    },
    {
      'identification_type': 'IDENTITY_DOCUMENT',
      'identity_document_step': {
        'provider_type': 'INTERNAL'
      }
    }
  ]
}" 

Responses

Code	Meaning	Description	Schema
201	Created	New chain identification is created.	CreateChainIdentificationResponse
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
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

Cancel a chained identification

Cancels an active chained identification. State will transition to CANCELLED. Also attempts to cancel any active nested identification steps. Identification chain status must be in a cancellable state, i.e. CREATED. 409 Conflict (MDOC_005) will be returned otherwise.

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

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
body	body	CancelIdentificationRequest	false	Optional reason for cancellation

Request body - instance of CancelIdentificationRequest

1
2
3


{
  "reason": "The client does not want to continue with the identification process."
}

Name	Type	Required	Description
reason	string	false	The reason why the process is going to be cancelled.

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}/cancel \
  -H "Content-Type: application/json" \
  -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" \
 --data-raw "{
  'reason': 'The client does not want to continue with the identification process.'
}" 

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
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

Close a chained identification process

Closes a chained identification process if it is in VALIDATED state. In case of SUCCEEDED, close will be ignored. If the process is not in the VALIDATED or SUCCEEDED state (e.g., CREATED, FAILED, EXPIRED, CANCELLED), it will return a 409 Conflict (MDOC_005), indicating the operation is not allowed in the current state. If the process is in VALIDATED state: Closes all nested identifications. Updates the chain process state to SUCCEEDED. Registers the close date/time.

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

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}/close \
  -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	Action executed correctly	None
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
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