Skip to main content
POST
/
verification-return-urls
Register a partner return URL for verification (pending admin approval)
curl --request POST \
  --url https://{host}/api/v1/verification-return-urls \
  --header 'API-key: <api-key>' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "partner_return_url": "<string>"
}
'
{
  "id": "<string>",
  "partner_id": 123,
  "status": "<string>",
  "requested_url": "<string>",
  "normalized_host": "<string>",
  "normalized_scheme": "<string>",
  "normalized_path_prefix": "<string>",
  "requested_at": "<string>"
}

Authorizations

​
Authorization
string
header
required

Sanctum personal access token (access_tokens / partner API settings).

​
API-key
string
header
required

UUID API key stored for the partner user.

Body

application/json
​
partner_return_url
string
required
Maximum string length: 2048

Response

Request recorded; await approval before using this URL in POST …/verification/flows.

Record of a partner’s return-URL request. Treat requested_url and status as the source of truth for what is approved. The normalized_* fields supplement host/scheme display and internal storage; matching for flows is based on requested_url approval and server rules, not on interpreting normalized_path_prefix alone.

​
id
string
required
​
partner_id
integer
required
​
status
string
required

Approval workflow state (e.g. pending admin review vs approved); exact values are implementation-defined.

​
requested_url
string
required

URL string you registered; this is what the server uses (with trim and dynamic-segment rules) to decide if a partner_return_url in POST …/verification/flows is allowed.

​
normalized_host
string
required

Host parsed from the registered URL (display and bookkeeping). Flow matching is not defined solely by this field.

​
normalized_scheme
string
required

Scheme parsed from the registered URL; production requires https except in API test mode.

​
normalized_path_prefix
string
required

Storage / uniqueness key derived from the registered URL (e.g. hash). Do not use this alone to infer which paths are allowed — use requested_url and approval status.

​
requested_at
string
required