Skip to main content
POST
Register a partner return URL for verification (pending admin approval)

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.

Response matches the partner API controller — only the fields below. Use requested_url and status to track approval; flow matching uses the approved requested_url (plus dynamic-segment rules), not any separate normalized fields in this payload.

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

Canonical URL string stored for this request; once approved, partner_return_url in POST …/verification/flows is matched against approved rows per server rules.

requested_at
string<date-time>
required

When this request was recorded (ISO-8601).