Scoring

Create scoring

POST /orgs/{org_id}/scorings/identity_document

Parameters

Name	In	Type	Required	Description
org_id	path	string	true	The string id related with tenants which contract belongs to
body	body	CreateScoringRequest	true	Data to create scoring

Request body - instance of CreateScoringRequest

1
2
3
4
5
6
7
8


{
  "document": {
    "type": "IDENTITY_CARD",
    "country": "ES"
  },
  "provider": "GOOGLE",
  "expires_in": "P7D"
}

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.

Request example

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



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'
}" 

Responses

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

Get identity document captures

GET /orgs/{org_id}/scorings/identity_document/{scoring_id}/captures

Parameters

Name	In	Type	Required	Description
org_id	path	string	true	The string id related with tenants which contract belongs to
scoring_id	path	string	true	Scoring id

Request example

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	Meaning	Description	Schema
200	OK	Expected response to a valid request.	GetCapturesResponse
400	Bad Request	Request input is not valid	ErrorsResponse
401	Unauthorized	The user is not authorized	ErrorsResponse
404	Not Found	The specified resource was not found	ErrorsResponse
500	Internal Server Error	The request failed to be processed by the server	ErrorsResponse
default	Default	Error response	ErrorsResponse

Get identity document scoring

GET /orgs/{org_id}/scorings/identity_document/{scoring_id}

Parameters

Name	In	Type	Required	Description
org_id	path	string	true	The string id related with tenants which contract belongs to
scoring_id	path	string	true	Scoring id

Request example

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	Meaning	Description	Schema
200	OK	Expected response to a valid request.	IdentityDocumentScoring
400	Bad Request	Request input is not valid	ErrorsResponse
401	Unauthorized	The user is not authorized	ErrorsResponse
404	Not Found	The specified resource was not found	ErrorsResponse
500	Internal Server Error	The request failed to be processed by the server	ErrorsResponse
default	Default	Error response	ErrorsResponse

Submit identity document images for scoring

Uploads front and/or back images of the identity document to perform fraud and authenticity checks, updating the scoring session with results.

PUT /orgs/{org_id}/scorings/identity_document/{scoring_id}/score

Parameters

Name	In	Type	Required	Description
org_id	path	string	true	Unique identifier of the organization (tenant) that owns this scoring session.
scoring_id	path	string	true	Unique identifier of the identity document scoring session to update.
body	body	object	false	Multipart payload containing binary images for the front and/or back of the document to be evaluated.

1

{}

None

Request example

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	Meaning	Description	Schema
204	No Content	Identity document scored successfully; no content returned.	None
400	Bad Request	Request input is not valid	ErrorsResponse
401	Unauthorized	The user is not authorized	ErrorsResponse
404	Not Found	The specified resource was not found	ErrorsResponse
500	Internal Server Error	The request failed to be processed by the server	ErrorsResponse
default	Default	Error response	ErrorsResponse

Close identity document scoring

Finalizes and closes the scoring session, preventing any further image submissions or status changes.

POST /orgs/{org_id}/scorings/identity_document/{scoring_id}/close

Parameters

Name	In	Type	Required	Description
org_id	path	string	true	Unique identifier of the organization (tenant) that owns this scoring session.
scoring_id	path	string	true	Unique identifier of the identity document scoring session to close.

Request example

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	Meaning	Description	Schema
204	No Content	Scoring session successfully closed; no content returned.	None
400	Bad Request	Request input is not valid	ErrorsResponse
401	Unauthorized	The user is not authorized	ErrorsResponse
404	Not Found	The specified resource was not found	ErrorsResponse
500	Internal Server Error	The request failed to be processed by the server	ErrorsResponse
default	Default	Error response	ErrorsResponse

Delegate identity document scoring

Sends the scoring request to an external provider and returns the provider’s access details.

POST /orgs/{org_id}/scorings/identity_document/{scoring_id}/delegate

Parameters

Name	In	Type	Required	Description
org_id	path	string	true	Unique identifier of the organization (tenant) that owns this scoring session.
scoring_id	path	string	true	Unique identifier of the identity document scoring session to delegate.

Request example

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	Meaning	Description	Schema
200	OK	Delegation successful; returns external provider credentials and metadata.	DelegateIdentityDocumentResponse
400	Bad Request	Request input is not valid	ErrorsResponse
401	Unauthorized	The user is not authorized	ErrorsResponse
404	Not Found	The specified resource was not found	ErrorsResponse
500	Internal Server Error	The request failed to be processed by the server	ErrorsResponse
default	Default	Error response	ErrorsResponse