masstack

Documents API

V1
API Overview Resources Schemas

Scoring services

Parameters

NameDescription

org_id*required

string

(path)

The string id related with tenants which contract belongs to

body*required

CreateScoringRequest

(body)

Data to create scoring

Request body - instance of CreateScoringRequest

Read only

format_sizelight_mode
content_copy
1
2
3
4
5
6
7
8
9

{
  "document": {
    "type": "IDENTITY_CARD",
    "country": "ES"
  },
  "provider": "GOOGLE",
  "expires_in": "P7D",
  "max_score_retries": 5
}
Name Type Required Description
document Document true Structure defining the document’s classification and issuing country.
provider Provider true Name of the external service provider used for performing the document verification (e.g., GOOGLE, VERIDAS).
expires_in ExpiresIn true ISO-8601 duration string specifying how long (minimum 1 minute, maximum 30 days) the scoring session will remain active.
max_score_retries MaxScoreRetries false Maximum number of retries allowed for scoring attempts. This helps prevent abuse or excessive retries. By default, it is set to 5 retries.

Request example

Read only

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


curl -X POST https://documents.masstack.com/v1/orgs/yoigo/scorings/identity_document \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
 --data-raw "{
  'document': {
    'type': 'IDENTITY_CARD',
    'country': 'ES'
  },
  'provider': 'GOOGLE',
  'expires_in': 'P7D',
  'max_score_retries': 5
}"

Responses

Code Description Schema
200 Expected response to a valid request. CreateScoringResponse
400 Request input is not valid ErrorsResponse
401 The user is not authorized ErrorsResponse
404 The specified resource was not found ErrorsResponse
500 The request failed to be processed by the server ErrorsResponse
default Error response ErrorsResponse

Parameters

NameDescription

org_id*required

string

(path)

The string id related with tenants which contract belongs to

scoring_id*required

string

(path)

Scoring id

Request example

Read only

format_sizelight_mode
content_copy
1
2
3
4


curl -X GET https://documents.masstack.com/v1/orgs/yoigo/scorings/identity_document/d290f1ee-6c54-4b01-90e6-d701748f0851/captures \
  -H "Accept: application/json"

Responses

Code Description Schema
200 Expected response to a valid request. GetCapturesResponse
400 Request input is not valid ErrorsResponse
401 The user is not authorized ErrorsResponse
404 The specified resource was not found ErrorsResponse
500 The request failed to be processed by the server ErrorsResponse
default Error response ErrorsResponse

Parameters

NameDescription

org_id*required

string

(path)

The string id related with tenants which contract belongs to

scoring_id*required

string

(path)

Scoring id

Request example

Read only

format_sizelight_mode
content_copy
1
2
3
4


curl -X GET https://documents.masstack.com/v1/orgs/yoigo/scorings/identity_document/d290f1ee-6c54-4b01-90e6-d701748f0851 \
  -H "Accept: application/json"

Responses

Code Description Schema
200 Expected response to a valid request. IdentityDocumentScoring
400 Request input is not valid ErrorsResponse
401 The user is not authorized ErrorsResponse
404 The specified resource was not found ErrorsResponse
500 The request failed to be processed by the server ErrorsResponse
default Error response ErrorsResponse

Parameters

NameDescription

org_id*required

string

(path)

Unique identifier of the organization (tenant) that owns this scoring session.

scoring_id*required

string

(path)

Unique identifier of the identity document scoring session to update.

body

object

(body)

Multipart payload containing binary images for the front and/or back of the document to be evaluated.

Read only

format_sizelight_mode
content_copy
1

{}
None

Request example

Read only

format_sizelight_mode
content_copy
1
2
3
4
5
6


curl -X PUT https://documents.masstack.com/v1/orgs/yoigo/scorings/identity_document/d290f1ee-6c54-4b01-90e6-d701748f0851/score \
  -H "Content-Type: multipart/mixed" \
  -H "Accept: application/json" \
 --data-raw "'string'"

Responses

Code Description Schema
204 Identity document scored successfully; no content returned. None
400 Request input is not valid ErrorsResponse
401 The user is not authorized ErrorsResponse
404 The specified resource was not found ErrorsResponse
500 The request failed to be processed by the server ErrorsResponse
default Error response ErrorsResponse

Parameters

NameDescription

org_id*required

string

(path)

Unique identifier of the organization (tenant) that owns this scoring session.

scoring_id*required

string

(path)

Unique identifier of the identity document scoring session to close.

Request example

Read only

format_sizelight_mode
content_copy
1
2
3
4


curl -X POST https://documents.masstack.com/v1/orgs/yoigo/scorings/identity_document/d290f1ee-6c54-4b01-90e6-d701748f0851/close \
  -H "Accept: application/json"

Responses

Code Description Schema
204 Scoring session successfully closed; no content returned. None
400 Request input is not valid ErrorsResponse
401 The user is not authorized ErrorsResponse
404 The specified resource was not found ErrorsResponse
500 The request failed to be processed by the server ErrorsResponse
default Error response ErrorsResponse

Parameters

NameDescription

org_id*required

string

(path)

Unique identifier of the organization (tenant) that owns this scoring session.

scoring_id*required

string

(path)

Unique identifier of the identity document scoring session to delegate.

Request example

Read only

format_sizelight_mode
content_copy
1
2
3
4


curl -X POST https://documents.masstack.com/v1/orgs/yoigo/scorings/identity_document/d290f1ee-6c54-4b01-90e6-d701748f0851/delegate \
  -H "Accept: application/json"

Responses

Code Description Schema
200 Delegation successful; returns external provider credentials and metadata. DelegateIdentityDocumentResponse
400 Request input is not valid ErrorsResponse
401 The user is not authorized ErrorsResponse
404 The specified resource was not found ErrorsResponse
500 The request failed to be processed by the server ErrorsResponse
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

Identification Chain

Identification Chain Admin