API REFERENCE - EVENT TRACKER

• Service Documentation: "Create Process"

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

• Service Name: Create Process
• URL: {URL_BASE}/api/EventTracer/CreateProcess
• Method: POST
• Functionality: Generates a unique identifier for a new verification process, enabling event tracking within SDKs.

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.

• x-api-key: Your API key for authentication.
• CustomerId (optional): A unique identifier for the customer initiating the process.
• SessionId (optional): A unique session identifier for the process.
• Source: Indicates the source of the process initiation, such as "SDK" or "WEB-SDK".
• SourceVersion: The version of the source initiating the process.
• Type: The type of process being initiated, either "ENROLL" or "VERIFY".
• Platform: The platform from which the process is initiated, such as "IOS", "ANDROID", or "DESKTOP".

• SO (optional): The operating system of the device used in the process.

• Brand (optional): The brand of the device used in the process.
• Model (optional): The model of the device used in the process.
• ClientName: The name of the client initiating the process.
• ProjectName: The name of the project under which the process is initiated.
• ProductName: The name of the product under which the process is initiated.

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

• Code: 200
• Content:

{
  "GUID": "unique_identifier_string"
}

• Description: This response indicates that the process was successfully created. The JSON object contains a GUID (Globally Unique Identifier) representing the newly created process identifier.

Client Error Response

• Code: 400
• Content:

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

• Description: This response is returned when the request fails due to invalid or incomplete data provided by the client. It suggests that the submitted parameters do not align with what the service expects.

Unauthorized Error Response

• Code: 401
• Content:

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

• 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.

Server Error Response

• Code: 500
• Content:

{
  "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:

• Success (200): Extract and store the GUID for use in tracking events related to this process. This identifier is essential for associating subsequent SDK events with the created process.
• Client Error (400): Review the request to ensure all required parameters are correctly formatted and included. Provide feedback to the user if necessary, prompting them to correct any errors.
• Unauthorized Error (401): Ensure the API key is correct and has the necessary permissions. Guide the user to verify their API key or contact support for access issues.
• Server Error (500): Implement retry logic or error handling to manage situations where the server is temporarily unable to handle requests. Inform the user of the issue and possibly provide instructions on next steps or retry options.

Implementation Notes

• Security: Ensure the x-api-key is securely stored and transmitted.
• Parameter Selection: While parameters are optional, providing CustomerId and SessionId enhances the ability to track and analyze the verification process.
• Error Handling: Implement appropriate error handling to manage potential issues, such as network errors or unauthorized access.

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.