Skip to main content
POST
/
customers
/
{id}
/
verifications
Start a verification
curl --request POST \
  --url https://api.lumx.io/customers/{id}/verifications \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "associatedPartyIds": [
    "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  ]
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Documentation Index

Fetch the complete documentation index at: https://docs.lumx.io/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer authentication header on the format Bearer <API_KEY>.

Headers

​
Idempotency-Key
string<uuid>

Optional UUID v4 idempotency key. If you resend the same key with a different request body, the API returns a 409 error. Cached responses include the header X-Idempotency-Cached: true. Keys expire after 24 hours.

Path Parameters

​
id
string<uuid>
required

Customer's unique identifier.

Body

application/json
​
associatedPartyIds
string<uuid>[]

Optional list of associated party IDs to retry verification for, in isolation. When provided, only these associated parties are sent for verification again; the customer's overall verification is not restarted. Applies only to BUSINESS customers.

Response

201 - application/json

Verification successfully started.

​
id
string<uuid>

Verification's unique identifier.