/api/v1/selphid/custom-event/ocr

Sends a custom external OCR event to the Api Tracking platform.

post

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

Data to register an external OCR event in the Api Tracking platform.

jsonDatastringRequired

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" }

eventSourcestringOptional

The source of an event in the Api Tracking service.

Example: event.source.externalTool

extraDatastringRequired

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

Example: BQABAQGkJhiCqQjKYUZyDM...

Responses

200

Result of the event tracking.

application/json

The result of an Api Tracking operation.

trackingStatusnumberOptional

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

Example: 201

trackingMessagestringOptional

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

Example: EvaluatePassiveLivenesWithImageBuffer: Ok

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/custom-event/ocr

POST /api/v1/selphid/custom-event/ocr HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 878

{
  "jsonData": "{ \"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\" } ",
  "eventSource": "event.source.externalTool",
  "extraData": "BQABAQGkJhiCqQjKYUZyDM..."
}

{
  "trackingStatus": 201,
  "trackingMessage": "EvaluatePassiveLivenesWithImageBuffer: Ok"
}