Partner User ID

The Partner User ID is a value generated and managed by the partner to link our internal screening records with the partner’s own user database. When a new screening is created, the partner provides their token (Partner User ID) via our API. We persist this value alongside our internal userId, and then return it in every webhook payload (as well as in any API response related to screening results) under the partnerUserId field. This allows the partner to reconcile events in our system with their own records.

How to Obtain Screening Links

Instead of manually constructing URLs, partners must now use the Generate Screening Links endpoint. This API generates both the WebApp and WhatsApp links with the Partner User ID correctly embedded and short-linked.

Generate Links Endpoint

Retrieves the unique screening links for a specific candidate/partner user from this endpoint

Path Parameters

Parameter	Type	Description
`screeningId`	string	The unique identifier of the screening provided by DigAI.
`partnerUserId`	string	The unique identifier for the user in the Partner's system (your token).

Response

The API returns a JSON object containing the pre-formatted links ready to be sent to the user.

{
  "message": [
    "Operation completed successfully"
  ],
  "data": {
    "value": {
      "whatsappLink": "https://i7w.me/zZZXXyyY",
      "webappLink": "https://www.digai.ai/jy?id=xxzzyy&gbt=aaBBCC"
    }
  }
}

Usage

Call the API: Pass the screeningId and your partnerUserId.

Receive Links: The response contains:

whatsappLink: A fully formatted WhatsApp deep link (including the message text and embedded ID).
webappLink: A direct link to the web application screening flow.

Distribute: Send these exact links to your users. No further string manipulation or parameter appending is required.

Storage and Propagation

Storage: When a user clicks either the WebApp or WhatsApp link, DigAI captures the partner’s token (PARTNER_USER_ID) from the URL (or message body) and stores it alongside our internal userId.
Webhook Payload: Every time DigAI emits a webhook for that screening event, it will include this value under the partnerUserId field. This allows the partner to match incoming webhook events against their own user records without having to store or convert our internal userId.