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
FieldTypeRequiredDescription
AuthorisationstringYesThe 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
  }
}
FieldTypeRequiredDescription
imageFrontstringYesImage from document in Base64 format. It's required to provide this image for verification.
imageBackstringOptionalImage 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": {}
            }
        }
    }
}
FieldTypeDescription
eventstringID for demand traceability.
requeststringID for demand traceability.
statusstringStatus of prosecution
ProcessingTimestringTest processing time for milliseconds.
statusObjectDetailed status of extraction processing
contentObjectContains information about the contents extracted from the document

Object * state *

FieldTypeDescription
completebooleanIt indicates whether the document has been completely captured from all required sides.
messagestringIt provides additional details in case of errors or discrepancies with expected results.

Subject matter * content *

FieldTypeDescription
dataObjectContains user information extracted from document (see sub-tables)

Object * content.data *

FieldTypeDescription
personnelSubject matterContains information from person extracted from document
addressSubject matterContains information from the address drawn from the document
documentSubject matterContains information from document extracted

Object * content.data.personal *

FieldTypeDescription
firmNamestringFirst name of user Used for blacklist service
secondstringSecond name of user (may be empty).Used for blacklist service
surnamestringLast name of the user.Used for blacklist service
motherSurnamestringMast name of the user.Used for blacklist service
fullNamestringFull name of user.
sexstringUser gender (H for man and M for woman).
dateofBirthstringDate of birth in DD / MM / AAAA format.
facestringImage from the face of the user in base64 format. Use this image for One To One service
placeOffBirthstringPlace of birth (may be empty).
nationalitystringUser nationality.Used for blacklist service
Maritime StatusstringCivil status (may be empty).
extraObjectAdditional information obtained from document
extra.ocrstringOCR number of the document (may be empty).Used for the blacklist service
extra.registerYearstringRegistration year of the document (may be empty).
extra.rfcstringFederal Taxpayer Registry (RFC) of the user (may be empty) (Mexican documents)Used for the blacklist service

Object * content.data.address *

FieldTypeDescription
fullAddressstringFull user address in text format.
postalCodestringHome code.
Ex.streetstringHome phone.
Ex.ExteriorstringExterior number of the address.
Ex.internalNumberstringIndoor number (may be empty).
extra.neighborhoodstringUser gender (H for male, M for female).
extra.citystringCity of residence.
ex.statestringState entity of residence.

Object * content.data.document *

FieldTypeDescription
TypestringType of document. See list
sidestringProjected document sides (BOTH for both sides).
CountryObjectInformation from the issuing country
numberstringIdentification document number.
personalstringUser's personal identification number.Used for blacklist service
AddendumstringAdditional document identification number (may be empty).Used for blacklist service
dateofIssuestringDate of issue of document.
inspirationObjectExpirand information
issuingAuthoritystringThe document's issuing authority (may be empty).
extraObjectAdditional information obtained from document (may be empty).

Object * content.data.document.country *

FieldTypeDescription
namestringName of issuing country.
isoAlpha3CodestringCode ISO Alpha-3 from the country
IsoAlpha2CodestringCode ISO Alpha-2 from the country
icaoCodestringdocument code

Object * content.data.document.escape *

FieldTypeDescription
datestringExpiry date of document.
isPermanentbooleanWhether 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.