Register a partner return URL for verification (pending admin approval)
Submits a request to register a URL for use as partner_return_url in verification flows. The 201 body includes requested_url (canonical string stored for this request) and status — 201 does not mean the URL is already approved; wait until status is approved before relying on it.
When starting flows, the server matches incoming partner_return_url against an approved stored requested_url using trim rules and optional dynamic path segments (see server implementation). Internally the app may store derived keys for uniqueness — those are not returned in this endpoint’s JSON.
Until approved, POST /users/{id}/verification/flows with that return URL may fail with 422.
Authorizations
Sanctum personal access token (access_tokens / partner API settings).
UUID API key stored for the partner user.
Body
2048Response
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.
Approval workflow state (e.g. pending admin review vs approved); exact values are implementation-defined.
Canonical URL string stored for this request; once approved, partner_return_url in POST …/verification/flows is matched against approved rows per server rules.
When this request was recorded (ISO-8601).