For the complete documentation index, see llms.txt. This page is also available as Markdown.

Extract Document Data

This service returns all data extracted from an identification document by applying OCR to the MRZ code, PDF, barcode, and visible fields in other areas of the document according to the model defined for each country.

Integration

This service is used for implementations of the SelphID Mobile Widget sending the property TokenOCR generated from the Widget's native function.

Endpoint

POST /services/extractDocumentData

Headers

Name
Type
Required
Description

x-api-key

string

Yes

Access authorization API key.

family

string

No

Value: Onboarding. Required with the tracking service.

All calls to the Endpoints for Tracking with Identity Platform must contain the header family.

Request body

Content-Type: application/json

Parameters

Parameter
Type
Required
Description

tokenOcr

string

Yes

Token generated by the native or hybrid SelphID Widget, encrypted with AES256 and Tokenized, sent in the format Base64. It contains the OCR result of the document capture.

tracking

object

No

Object that represents the necessary tracking information.

tracking.extraData

string

No

Token generated by the Mobile/Web SDK. Contains tokenized tracking information with the Platform.

tracking.operationId

string

No

Operation identifier generated by the Mobile/Web SDK.

Request example

Responses

200 Success

Response parameters

Parameter
Type
Description

serviceResultCode

integer

Code indicating the overall result of service execution. See Service Result Code

serviceResultLog

string

Descriptive field of the result of the service execution. Module details are included in case of error or exception.

serviceDocument

string

Object representing the captured document. Its properties are all fields extracted by the OCR process.

serviceTime

string

Total service execution time (milliseconds).

serviceTransactionId

string

Transaction identifier associated with the request processed by the API.

Service Result Code

The serviceResultCode indicates the overall result of the service execution:

serviceResultCode
Description
HTTP code

0

The service execution was successful, the module processed the request correctly.

200

Response example

400 Bad Request

401 Unauthorized

403 Forbidden

502 Bad Gateway

504 Gateway Timeout

Last updated