masstack

V1
API Overview Resources Schemas

Identification Agent

Digital agent identification services

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 ValidateAgentIdentificationRequest false Required data to execute action

Request body - instance of ValidateAgentIdentificationRequest

1
2
3
4
5

{
  "agent": "Jose Luis Garcia",
  "evidence": "iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAABbklEQVR42mNkAAYYgZ",
  "evidence_metadata": "{ \"document_number\": \"12345678A\",\n  \"document_type\": \"NIF\" }"
}
Name Type Required Description
agent string true shop agent identifier of who is validating this identification
evidence PersonalDocumentImage false Evidence of the actor identified. It should be a personal document image. Uploaded in Base64 string format. Image extension should ONLY ‘*.png’
evidence_metadata PersonalIdentificationEvidenceMetadata false Metadata of apply OCR to Evidence file. It should be in a valid Json format.

Request example

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


curl -X POST https://documents.masstack.com/v1/orgs/{org_id}/identifications/agent/{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 "{
  'agent': 'Jose Luis Garcia',
  'evidence': 'iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAABbklEQVR42mNkAAYYgZ',
  'evidence_metadata': '{ \'document_number\': \'12345678A\',\n  \'document_type\': \'NIF\' }'
}"

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
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/agent/{identification_id} \
  -H "Accept: application/json"

Responses

Code Meaning Description Schema
200 OK Expected response for a valid request. GetAgentIdentificationMetadataResponse
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

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