Scoring

Scoring services


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 DocumentType1 true Document type
provider Provider true Scoring provider. Possible values [GOOGLE, VERIDAS]
expires_in ExpiresIn true Minimum 1 minute. Max 30 days. Validity duration time (ISO-8601 format) from now.

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

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. IdentityDocument
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

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
body body object false Data to score identity document
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
200 OK Action executed correctly IdentityDocument
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

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 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 Action executed correctly IdentityDocument
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

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 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 Action executed correctly 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

Endpoints

Documents

    Forms

      Sections

        Templates

          Templates Configuration

            Digital Sign Process

              Biometric Signature

                Simple Signature

                  Identification Agent

                    Sign Configuration

                      Identification OTP

                        Identification Agent Admin

                          Identification OTP Admin

                            Contracts

                              Scoring

                                Securize