/api/v1/selphid/document/extract

Extracts raw data (OCR and images) from a tokenized document.

post

Autorizações

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Corpo

A tokenized document and, additionally, an extraData for registration in Api Tracking.

tokenstringObrigatório

Tokenized document data (OCR, faceImage, frontImage, backImage), base64-encoded.

Example: BQABAQGc2xyGocf4XuscMiY...

extraDatastringOpcional

Tokenized data used to call the Api Tracking service after the operation, base64-encoded.

Example: BQABAQGkJhiCqQjKYUZyDM...

Respostas

200

Result of the document extraction.

application/json

The result of a document extraction operation.

documentDatastringOpcional

String containing a JSON key/value dictionary with the OCR fields detected in a document.

Example: { "Back/INPUT/Issuer": "ESP", "Back/MRZ/DateOfBirth": "01/08/1974", "Back/MRZ/DateOfExpiry": "18/04/2023", "Back/MRZ/DocumentCode": "ID", "Back/MRZ/DocumentNumber": "99999999X", "Back/MRZ/FirstName": "JOSE JAVIER", "Back/MRZ/FullName": "JOSE JAVIER PEREZ PEREZ", "Back/MRZ/Gender": "M", "Back/MRZ/IDCardNumber": "ANR145111", "Back/MRZ/Issuer": "ESP", "Back/MRZ/LastName": "PEREZ PEREZ", "Back/MRZ/MrzText": "IDESPANR999999999999999X<<<<<< 888888888888888ESP<<<<<<<<<<<9 PEREZ<PEREZ<<JOSE<JAVIER<<<<<< ", "Back/MRZ/Nationality": "ESP", "Back/MRZ/NfcKey": "ANR11111111", "Back/MRZ/PrimaryID": "PEREZ PEREZ", "Back/MRZ/SecondaryID": "JOSE JAVIER", "Back/MRZ/Verified": "YES", "DocumentModel": "DNI Digital" }

validTimeStampbooleanOpcional

In authentication, liveness and extraction operations that involve templateRaws, indicates whether the template's lifetime is valid. See "options:elapsedAllowedSeconds". In operations that do not involve raw templates, it is always true.

Example: true

tokenTimeStampstringOpcional

The token's internal date and time value in "%Y-%m-%dT%H:%M:%SZ" format.

Example: 2022-01-14T10:42:05.521922Z

trackingStatusnumberOpcional

Status returned by the Api Tracking service, or -1 if tracking is not required.

Example: 201

trackingMessagestringOpcional

Message returned by the Api Tracking service, or empty if tracking is not required.

Example: EvaluatePassiveLivenesWithImageBuffer: Ok

sdkDurationnumberOpcional

Duration of the operation in milliseconds.

Example: 1234

400

Incorrect parameters in the request.

application/json

500

An error occurred in the call to the SelphID-SDK backend.

application/json

post/api/v1/selphid/document/extract

POST /api/v1/selphid/document/extract HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 78

{
  "token": "BQABAQGc2xyGocf4XuscMiY...",
  "extraData": "BQABAQGkJhiCqQjKYUZyDM..."
}

{
  "documentData": "{ \"Back/INPUT/Issuer\": \"ESP\", \"Back/MRZ/DateOfBirth\": \"01/08/1974\", \"Back/MRZ/DateOfExpiry\": \"18/04/2023\", \"Back/MRZ/DocumentCode\": \"ID\", \"Back/MRZ/DocumentNumber\": \"99999999X\", \"Back/MRZ/FirstName\": \"JOSE JAVIER\", \"Back/MRZ/FullName\": \"JOSE JAVIER PEREZ PEREZ\", \"Back/MRZ/Gender\": \"M\", \"Back/MRZ/IDCardNumber\": \"ANR145111\", \"Back/MRZ/Issuer\": \"ESP\", \"Back/MRZ/LastName\": \"PEREZ PEREZ\", \"Back/MRZ/MrzText\": \"IDESPANR999999999999999X<<<<<<\n888888888888888ESP<<<<<<<<<<<9\nPEREZ<PEREZ<<JOSE<JAVIER<<<<<<\n\", \"Back/MRZ/Nationality\": \"ESP\", \"Back/MRZ/NfcKey\": \"ANR11111111\", \"Back/MRZ/PrimaryID\": \"PEREZ PEREZ\", \"Back/MRZ/SecondaryID\": \"JOSE JAVIER\", \"Back/MRZ/Verified\": \"YES\", \"DocumentModel\": \"DNI Digital\" } ",
  "imageData": {
    "faceImage": "/9j/4AAQSkZJRgABAQAAAQABAAD/...",
    "documentFrontImage": "/9j/4AAQSkZJRgABAQAAAQABAAD/...",
    "documentBackImage": "/9j/4AAQSkZJRgABAQAAAQABAAD/..."
  },
  "validTimeStamp": true,
  "tokenTimeStamp": "2022-01-14T10:42:05.521922Z",
  "trackingStatus": 201,
  "trackingMessage": "EvaluatePassiveLivenesWithImageBuffer: Ok",
  "sdkDuration": 1234
}