API REFERENCE - EVENT TRACKER

Service Documentation: "Create Process"

The "Create Process" service is designed to generate a unique process identifier, facilitating the tracking and association of events emitted by SDKs during identity verification processes. This service is essential for maintaining a coherent event log and ensuring that each action within the SDKs can be accurately monitored and related back to a specific verification process.

Service Overview

Request Parameters

The service accepts various parameters submitted as form data. While all parameters are optional, it is recommended to always send the CustomerId and SessionId for optimal tracking and analysis.

Example CURL Request

curl --location 'https://api-dev.ado-tech.com/api/EventTracer/CreateProcess' \
--header 'x-api-key: your_api_key' \
--form 'CustomerId="unique_customer_id"' \
--form 'SessionId="unique_session_id"' \
--form 'Source="SDK or WEB-SDK"' \
--form 'SourceVersion="5.1.2"' \
--form 'Type="ENROLL or VERIFY"' \
--form 'Platform="IOS or ANDROID or DESKTOP"' \
--form 'SO="operating_system"' \
--form 'Brand="device_brand"' \
--form 'Model="device_model"' \
--form 'ClientName="client_name"' \
--form 'ProjectName="project_name"'
--form 'ProductName="product_name"'

Replace placeholder values (e.g., your_api_key, unique_customer_id, etc.) with actual data relevant to your verification process.

Response Structure for "Create Process" Service

Upon making a request to the "Create Process" service, the server will respond with a status code indicating the outcome of the request. Below are the possible responses you might receive:

Successful Response

{
  "GUID": "unique_identifier_string"
}

Client Error Response

{
  "Bad Request": "The provided data does not meet the expected criteria."
}

Unauthorized Error Response

{
  "Unauthorized": "Invalid API key or insufficient permissions."
}

Server Error Response

{
  "Internal Server Error": "An error occurred on the server."
}

Description: This response indicates that the server encountered an unexpected condition that prevented it from fulfilling the request. It is a generic error message, implying that the issue lies with the server rather than the request itself.

Handling Responses

When integrating the "Create Process" service into your application, it's crucial to implement logic that appropriately handles each of these responses:

By accurately handling these responses, you can ensure a smooth integration of the "Create Process" service, enhancing the reliability and user experience of your identity verification workflow.

Implementation Notes

By utilizing the "Create Process" service, clients can effectively manage and track events within their identity verification workflows, ensuring a coherent and traceable process from initiation to completion.