The aim of data collection is to capture and organize document information to facilitate its analysis and storage and this information will later be used in the following steps as monitoring document title and searching for data in blacklists.
To ensure the coherence and efficiency of the process, it's essential that you use the same images of the document both at the document's verification step and at this step. Remember that encoding the image to Base64 is crucial before sending them to service to ensure their proper transmission and processing.
Realizes next call API sending images or images of the document.
URL
POST https://api.sandbox.jaak.ai/api/v4/document/extract
Leader
Authorization: Bearer token-session-kyc
| Field | Type | Required | Description |
|---|---|---|---|
| Authorisation | string | Yes | The Session Token should be sent at this headquarters KYC That's been obtained from the exchange with Short Key |
Request
{
"imageFront": String,
"imageBack": String,
"documentSessionSelected": {
"country": String
}
}
| Field | Type | Required | Description |
|---|---|---|---|
| imageFront | string | Yes | Image from document in Base64 format. It's required to provide this image for verification. |
| imageBack | string | Optional | Image from the back of the document in Base64 format. It should be included if the document has a later counterparty. |
Answer
{
"eventId": String,
"requestId": String,
"status": String,
"processingTime": String,
"state": {
"message": String,
"documentCompleteSides": Boolean
},
"content": {
"data": {
"personal": {
"firstName": String,
"secondName": String,
"surname": String,
"motherSurname": String,
"fullName": String,
"sex": String,
"dateOfBirth": String,
"face": String,
"placeOfBirth": String,
"nationality": String,
"maritalStatus": String,
"extra": {
"ocr": String,
"registerYear": String,
"rfc": String
}
},
"address": {
"fullAddress": String,
"postalCode": String,
"extra": {
"street": String,
"externalNumber": String,
"internalNumber": String,
"neighborhood": String,
"city": String,
"state": String
}
},
"document": {
"type": String,
"side": String,
"country": {
"name": String,
"isoAlpha3Code": String,
"isoAlpha2Code": String,
"icaoCode": String
},
"number": String,
"personalIdNumber": String,
"additionalNumber": String,
"dateOfIssue": String,
"expiration": {
"date": String,
"isPermanent": Boolean
},
"issuingAuthority": String,
"extra": {}
}
}
}
}
| Field | Type | Description |
|---|---|---|
| event | string | ID for demand traceability. |
| request | string | ID for demand traceability. |
| status | string | Status of prosecution |
| ProcessingTime | string | Test processing time for milliseconds. |
| status | Object | Detailed status of extraction processing |
| content | Object | Contains information about the contents extracted from the document |
Object * state *
| Field | Type | Description |
|---|---|---|
| complete | boolean | It indicates whether the document has been completely captured from all required sides. |
| message | string | It provides additional details in case of errors or discrepancies with expected results. |
Subject matter * content *
| Field | Type | Description |
|---|---|---|
| data | Object | Contains user information extracted from document (see sub-tables) |
Object * content.data *
| Field | Type | Description |
|---|---|---|
| personnel | Subject matter | Contains information from person extracted from document |
| address | Subject matter | Contains information from the address drawn from the document |
| document | Subject matter | Contains information from document extracted |
Object * content.data.personal *
| Field | Type | Description |
|---|---|---|
| firmName | string | First name of user Used for blacklist service |
| second | string | Second name of user (may be empty).Used for blacklist service |
| surname | string | Last name of the user.Used for blacklist service |
| motherSurname | string | Mast name of the user.Used for blacklist service |
| fullName | string | Full name of user. |
| sex | string | User gender (H for man and M for woman). |
| dateofBirth | string | Date of birth in DD / MM / AAAA format. |
| face | string | Image from the face of the user in base64 format. Use this image for One To One service |
| placeOffBirth | string | Place of birth (may be empty). |
| nationality | string | User nationality.Used for blacklist service |
| Maritime Status | string | Civil status (may be empty). |
| extra | Object | Additional information obtained from document |
| extra.ocr | string | OCR number of the document (may be empty).Used for the blacklist service |
| extra.registerYear | string | Registration year of the document (may be empty). |
| extra.rfc | string | Federal Taxpayer Registry (RFC) of the user (may be empty) (Mexican documents)Used for the blacklist service |
Object * content.data.address *
| Field | Type | Description |
|---|---|---|
| fullAddress | string | Full user address in text format. |
| postalCode | string | Home code. |
| Ex.street | string | Home phone. |
| Ex.Exterior | string | Exterior number of the address. |
| Ex.internalNumber | string | Indoor number (may be empty). |
| extra.neighborhood | string | User gender (H for male, M for female). |
| extra.city | string | City of residence. |
| ex.state | string | State entity of residence. |
Object * content.data.document *
| Field | Type | Description |
|---|---|---|
| Type | string | Type of document. See list |
| side | string | Projected document sides (BOTH for both sides). |
| Country | Object | Information from the issuing country |
| number | string | Identification document number. |
| personal | string | User's personal identification number.Used for blacklist service |
| Addendum | string | Additional document identification number (may be empty).Used for blacklist service |
| dateofIssue | string | Date of issue of document. |
| inspiration | Object | Expirand information |
| issuingAuthority | string | The document's issuing authority (may be empty). |
| extra | Object | Additional information obtained from document (may be empty). |
Object * content.data.document.country *
| Field | Type | Description |
|---|---|---|
| name | string | Name of issuing country. |
| isoAlpha3Code | string | Code ISO Alpha-3 from the country |
| IsoAlpha2Code | string | Code ISO Alpha-2 from the country |
| icaoCode | string | document code |
Object * content.data.document.escape *
| Field | Type | Description |
|---|---|---|
| date | string | Expiry date of document. |
| isPermanent | boolean | Whether the document is permanent |
The * state * item, situated within the * Response *, shows the status of the document's extraction. That item includes a group of properties that indicate whether or not the document meets the extraction requirements.
JAAK recommends that all extraction properties be successfully completed for better safetywhile this isn't required so you can select only a set of properties as required. Some examples include:
- To demand capture of the missing or counterparty of the document if required.
- Request a new capture if an error exists within the collection of document data.
From the data extracted from the document at this stage, there are some that will be used in the following steps of the process. In the Section Verification in blacklists the data that are required are:
Service check INE in black lists
-
- content.data.document.additionalNumber * (CIC)
-
- content.data.personal.extra.ocr * (OCR)
Service check INTERPOL in black lists
-
- content.data.personal.name *
-
- content.data.personal.secondName *
-
- content.data.personal.sureName *
-
- content.data.personal.motherSurname *
Service check OFAC in black lists
-
- content.data.personal.name *
-
- content.data.personal.secondName *
-
- content.data.personal.sureName *
-
- content.data.personal.motherSurname *
Service check RENAPO in black lists
-
- content.data.document.personalIdNumber * (CURP)
Service check SAT in black lists
-
- content.data.personal.name *
-
- content.data.personal.secondName *
-
- content.data.personal.sureName *
-
- content.data.personal.motherSurname *
-
- content.data.personal.extra.rfc *
The necessary information obtained from this extraction is as follows:
-
- content.data.personal.face *
Once we have extracted and identified the document's data we will use them at the following steps.