🔗 Generate KYB onboarding link for a mandate

Request

Generate a Dotfile KYB onboarding link for a mandate in PENDING_KYB status.

If no KYB case exists yet for this mandate, one is created on the fly. If a case already exists, a fresh link is returned for it.

Security

APIKeyHeader

Headers

X-PDP-Client-Idstring(X-Pdp-Client-Id)required

ID of the PDP Client for which the operation is performed

Examples:

Sandbox client

client_abc123

Bodyapplication/jsonrequired

mandate_idstring(Mandate Id)required

ID of the mandate to generate a KYB link for

curl -i -X POST \
  https://pdp.seqino.dev/api/clients/onboarding-link \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -H 'X-PDP-Client-Id: client_abc123' \
  -d '{
    "mandate_id": "mdt_abc12345"
  }'

Responses

Onboarding link generated successfully

Bodyapplication/json

onboarding_urlstring(Onboarding Url)required

Generated KYB onboarding URL from Dotfile

mandate_idstring(Mandate Id)required

Mandate this link is associated with

expires_atstring, (date-time)(Expires At)required

When this onboarding link expires

Response

{
  "onboarding_url": "string",
  "mandate_id": "string",
  "expires_at": "2019-08-24T14:15:22Z"
}