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

Sends custom external closing and completion events of the OCR operation to the Api Tracking platform.

post

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

Data to register external operation closing and completion events in the Api Tracking platform.

statusstring · enumRequired

Result of a client-side operation, for registration in Api Tracking.

Example: SucceededPossible values:

reasonstring · enumRequired

Detail of the result of a client-side operation, for registration in Api Tracking.

Example: NonePossible values:

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/finish

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

{
  "status": "Succeeded",
  "reason": "None",
  "extraData": "BQABAQGkJhiCqQjKYUZyDM..."
}

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