masstack

V1
API Overview Resources Schemas

Identification with identity document Admin

Identification with identity document administrative services

Parameters

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

Request body - instance of CreateIdentityDocumentIdentificationRequest

 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

{
  "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"
  },
  "name": "James",
  "last_name": "Smith",
  "identity_document": {
    "document_number": "12345678A",
    "document_type": "NIF",
    "country": "ES"
  },
  "configuration_name": "HIGH",
  "expires_in": "P7D",
  "scoring": {
    "provider": "INTERNAL"
  }
}
Name Type Required Description
actor IdentificationActorCountry false none
name string false none
last_name string false none
identity_document IdentificationActorIdentityDocument false none
configuration_name string false Configuration name. Possible values: [“LOW”, “MEDIUM”, “HIGH”]
expires_in string false Default to 30 days. Max 30 days. Validity duration time (ISO-8601 format) from now.
scoring object false none
» provider string false Scoring provider to use: Possible values: [INTERNAL, EXTERNAL]

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


curl -X POST https://documents.masstack.com/v1/orgs/{org_id}/identifications/identity_document \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
 --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'
  },
  'name': 'James',
  'last_name': 'Smith',
  'identity_document': {
    'document_number': '12345678A',
    'document_type': 'NIF',
    'country': 'ES'
  },
  'configuration_name': 'HIGH',
  'expires_in': 'P7D',
  'scoring': {
    'provider': 'INTERNAL'
  }
}"

Responses

Code Meaning Description Schema
200 OK New agent identification is created. Expected response for a valid request. CreateIdentityDocumentIdentificationResponse
400 Bad Request Request input is not valid None
401 Unauthorized Unauthorized. AuthN and AuthZ validations have fail 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 identity document 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 false 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/identity_document/{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/identity_document/{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

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