masstack

V1
API Overview Resources Schemas

Identification OTP Admin

Digital OTP identification administrative services

Parameters

Name In Type Required Description
org_id path string true Organization name
body body CreateOtpIdentificationRequest true Data about actor and the otp identification process.

Request body - instance of CreateOtpIdentificationRequest

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22

{
  "actor": {
    "name": "James",
    "last_name": "Smith",
    "identity_document": {
      "document_number": "12345678A",
      "document_type": "NIF"
    },
    "email": "example@email.com",
    "msisdn": {
      "phone_number": 6123456789,
      "country_code": "34"
    },
    "language": "ES"
  },
  "expires_in": "P7D",
  "two_factor_type": "DOCUMENT_NUMBER",
  "channel": {
    "type": "SMS",
    "external": "true"
  }
}
Name Type Required Description
actor IdentificationActor true none
expires_in string true Default to 30 days. Max 30 days. Validity duration time (ISO-8601 format) from now.
two_factor_type TwoFactorType1 false Two factor type to validate actor identity. Possible values:
* DOCUMENT_NUMBER: value defined in actor’s document number field
* EMAIL: value defined in actor’s email field
* PERSONAL_DOCUMENT_IMAGE: Image of the document number (back and front) defined in actor’s document number field
channel CommunicationChannel true none

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


curl -X POST https://documents.masstack.com/v1/orgs/{org_id}/identifications/otp \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
 --data-raw "{
  'actor': {
    'name': 'James',
    'last_name': 'Smith',
    'identity_document': {
      'document_number': '12345678A',
      'document_type': 'NIF'
    },
    'email': 'example@email.com',
    'msisdn': {
      'phone_number': 6123456789,
      'country_code': '34'
    },
    'language': 'ES'
  },
  'expires_in': 'P7D',
  'two_factor_type': 'DOCUMENT_NUMBER',
  'channel': {
    'type': 'SMS',
    'external': 'true'
  }
}"

Responses

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

Parameters

Name In Type Required Description
org_id path string true Organization name
admin_identification_id path string true uuid identification unique identifier
body body CancelIdentificationRequest true Required data to cancel an identification process

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 true The reason why the process is going to be cancelled.

Request example

1
2
3
4
5
6
7
8


curl -X POST https://documents.masstack.com/v1/orgs/{org_id}/identifications/otp/{admin_identification_id}/cancel \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
 --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
500 Internal Server Error Not expected error None
default Default Error response ErrorsResponse

Parameters

Name In Type Required Description
org_id path string true Organization name
admin_identification_id path string true uuid identification unique identifier

Request example

1
2
3
4


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

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

Parameters

Name In Type Required Description
org_id path string true Organization name
admin_identification_id path string true uuid identification unique identifier
force query string false If the process is not in CREATED state this parameter has to be passed as true AND needed permission has to be present at the token for the deletion to happen. A FORBIDDEN code will be thrown otherwise.
- ‘true’ if identification process must be deleted regardless of the state.
- ‘false’ or not present otherwise.

Request example

1
2
3
4


curl -X DELETE https://documents.masstack.com/v1/orgs/{org_id}/identifications/otp/{admin_identification_id}?force='true' \
  -H "Accept: application/json"

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
500 Internal Server Error Not expected error None
default Default Error response ErrorsResponse

Endpoints

Documents

    Forms

      Sections

        Templates

          Templates Configuration

            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