/finishTracking

Description

This service completes the tracking process and should be invoked upon completing all validations in the Onboarding or Authentication flows. When this service is integrated, invoking the closeSession method from the Mobile/Web SDK is not required.

Request:

curl --location '{IDENTITY_API_BASE_URL}/services/finishTracking' \
--header 'x-api-key: {API_KEY}' \
--header 'Content-Type: application/json' \
--data '{
    "family": "OnBoarding",
    "status": "SUCCEEDED",
    "reason": "",
    "extraData": "string"
}'

Request parameters:

Parameter	Type (Content)	Required	Description
family	String	Yes	Possible values: Authentication, OnBoarding
status	String	Yes	Possible values: SUCCEEDED, DENIED, ERROR, CANCELLED, BLACKLISTED
reason	String	Yes	Possible values: DOCUMENT_VALIDATION_NOT_PASSED, DOCUMENT_VALIDATION_ERROR, FACIAL_AUTHENTICATION_NOT_PASSED, FACIAL_LIVENESS_NOT_PASSED, FACIAL_AUTHENTICATION_ERROR, FACIAL_LIVENESS_ERROR, BLACKLISTED_FACE_TEMPLATE, ALREADY_REGISTERED, MANUAL_STATUS_CHANGE, SECURITY_SERVICE_ERROR, SELPHID_INTERNAL_ERROR, SELPHID_TIMEOUT, SELPHI_TIMEOUT
extraData	String	Yes	Token generated by Mobile/Web SDK. Contains tokenized tracking information.

Example Response:

{
    "trackingStatus": 201,
    "trackingMessage": "FinishTrackingEvent: Ok",
    "transactionId": "123e4567-e89b-12d3-a456-426614174000",
    "timestamp": "2023-05-01T12:34:56.789Z"
}

Response fields:

Identifier	Type	Description
trackingStatus	Integer	Code indicating the result of the tracking service execution. Value 201: Service processed without exceptions.
trackingMessage	String	Message indicating the result of the tracking service execution. Value "FinishTrackingEvent: Ok": Service processed without exceptions.
transactionId	String	Transaction identifier associated with the request processed by the API.
timestamp	String	Timestamp (UTC) of the response in the format: YYYY-MM-DDThh:mm:ss.SSSZ