Skip to main content

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 (optional): Indicates the source of the process initiation, such as "SDK" or "WEB-SDK".
  • SourceVersion (optional): The version of the source initiating the process.
  • Type (optional): The type of process being initiated, either "ENROLL" or "VERIFY".
  • Platform (optional): 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 (optional): The name of the client initiating the process.
  • ProjectName (optional): The name of the project 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"'

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

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.

 

Back to top