Skip to main content
POST
Create a hosted verification link

What this endpoint does

Issues a hosted link where a customer completes identity or business verification.

When to use it

Create it after onboarding a customer that still needs verification, then redirect or send them to the returned URL.

Before you call

Use a secret API key with customer write access and pass a customer ID owned by this tenant account.

Money and balance effect

This changes a resource or configuration but does not directly reserve, debit, credit, or settle wallet money.

States and completion

The link only starts verification. The final result arrives asynchronously and updates the customer and entitlements.

Safe retries

Send a unique Idempotency-Key for the logical action. If the response is lost, retry the same payload with the same key; never create a new key merely because the first response timed out. Read Customers for the complete workflow.

Authorizations

Authorization
string
header
required

Send the same Wayex API key as Authorization: Bearer <key>.

Headers

Idempotency-Key
string
required

A unique key for this logical action. Reuse the same key and identical payload when retrying after an unknown response.

Required string length: 8 - 255

Path Parameters

id
string
required

Body

application/json
ttlSeconds
integer
Required range: 0 < x < 86400

Response

The hosted verification link.