Skip to main content

Use the API Key

Using Integrations

Once your integration is created and your API key is obtained, follow these steps to initiate and complete the KYC process.

Web Integration​

To use the Web Integration in your application, follow these steps:

Step 1: Start a KYC Session​

Send a POST request to the Start Session endpoint with your API key. This request will return a unique sessionId for the KYC process.

  • Endpoint: https://authenticalls.com/kyc/client/api/sessions/start
  • Method: POST
  • Headers: Include the API key in the headers for authentication
  • Request Body: Refer to the API specifications for the required fields in the request body.

Step 2: Launch the KYC Process​

Use the returned sessionId to open a new window or popup that initiates the KYC process. The URL format for the KYC process is:

https://authenticalls.com/kyc/client/app/intro?sessionId={sessionId}

Replace {sessionId} with the value received from the POST request.

Step 3: Handle the Callback Response​

After the KYC process is complete, the user will be redirected to your integration’s predefined callback URL. The response includes a validation ID in the query parameters, which allows you to access the result.

  • Callback URL Format: {callback_url}?validation={validationId}&session={sessionId}
  • Parameters:
    • validationId: The ID representing the validation result of the KYC process.
    • sessionId: The unique session ID for the KYC process.

Example Workflow​

Start a Session: Send a POST request with the API key. Initiate the KYC Process: Open https://authenticalls.com/kyc/client/app/intro?sessionId={sessionId} in a new window. Process the Response: Receive the KYC result at your callback URL with the validation ID.

Security Tip : Ensure the callback_url you set for your integration is secure and configured to handle KYC validation results correctly.

This completes the setup and usage of Web Integration for the KYC process.

Mobile Embedded Integration​

For Mobile Embedded Integration, follow these steps to initiate and complete the KYC process within a mobile application's webview.

Step 1: Start a KYC Session​

Send a POST request to the Start Session endpoint with your API key to obtain a unique sessionId for the KYC process.

  • Endpoint: https://authenticalls.com/kyc/client/api/sessions/start
  • Method: POST
  • Headers: Include the API key in the headers for authentication.
  • Request Body: Refer to the API specifications for details on required fields.

Step 2: Launch the KYC Process in Webview​

Use the sessionId to load the KYC process within the mobile app’s webview. The URL format for initiating the KYC process is:

https://authenticalls.com/kyc/client/app/intro?sessionId={sessionId}

After the KYC process is complete, the user will be redirected to your integration’s predefined deeplink callback URL within the mobile app. The response will include a validation ID in the query parameters, allowing you to access the result.

  • Deeplink Callback URL Format: {deeplink_url}?validation={validationId}&session={sessionId}
  • Parameters:
    • validationId: The ID representing the validation result of the KYC process.

Example Workflow​

  1. Start a Session: Send a POST request with the API key.
  2. Initiate the KYC Process: Open https://authenticalls.com/kyc/client/app/intro?sessionId={sessionId} in a webview.
  3. Process the Response: Receive the KYC result at your deeplink callback URL with the validation ID.

Security Tip: Ensure that the deeplink URL is properly secured and configured to handle KYC validation responses within your app.

This completes the setup and usage of Web Integration and Mobile Embedded Integration for the KYC process.

Mobile Integration​

For mobile applications handling the KYC process natively, we provide a React Native SDK to streamline implementation.

➡ @authenticalls/react-native-kyc-sdk

Head over to the NPM package page and follow the provided instructions to integrate the KYC process into your mobile app using the SDK.

Webhook Handling​

Once a manual review is completed, Authenticalls' servers will send a webhook response. To sync this data with your system, you should set up either:

  • A socket connection to receive real-time updates.
  • A polling mechanism on your server to periodically check for updates.

Ensure your implementation correctly handles webhook responses to finalize the KYC process in your system.

Additional API Resources​

For more detailed information on session management and other API functionalities, visit the Authenticalls KYC API documentation. This resource covers:

  • Session Status Checks: Monitor the current status of a KYC session.
  • Validation Status Retrieval: Programmatically access the results of a completed KYC validation.
  • Error Codes and Response Formats: Reference error handling guidelines and data formats for integration consistency.

These additional endpoints can help you manage KYC sessions and retrieve validation statuses efficiently.