Browse the docs

Create cardholder KYC link

POST /v2/api-gateway/cardholders/{id}/kyc-link

Returns { url, status } for the cardholder to complete identity verification. url is null when the cardholder is already in a status that cannot be restarted (APPROVED, IN_REVIEW, DECLINED); an existing, still-valid link is reused. Returns 200 (not 201).

Request

Authentication: your API key in the x-api-key header.

Path parameters

Field	Type	Description
`id` required	string, uuid	The Moon cardholder id (`id`, a UUID), not your `external_id`.

Headers

Field	Type	Description
`Idempotency-Key`	string	A unique string you choose, up to 255 characters, that makes this request safe to retry. If a request times out or fails in transit, send it again with the same key: the status code and body of the first attempt are returned and the operation is not performed a second time. Stored replies — including failures — are replayed for 24 hours, after which the same key starts a fresh request. Reusing a key for a different request, or sending it while the first request is still running, returns 409. Omit the header and the request behaves exactly as before. Document upload endpoints do not accept it.

Example request

cURL

curl --request POST \
     --url 'https://api.themooncard.com/v2/api-gateway/cardholders/3f5b1c2e-8d4a-4b6f-9e2a-1c7d8e9f0a1b/kyc-link' \
     --header 'x-api-key: YOUR_API_KEY'

Responses

200 Success

Field	Type	Description
`url` required	string, nullable	Hosted verification URL the cardholder opens to complete identity verification. Null when the cardholder is already in a status that cannot be restarted (`APPROVED`, `IN_REVIEW`, `DECLINED`).
`status` required	string	Current KYC status: `NOT_STARTED`, `IN_REVIEW`, `APPROVED`, `DECLINED` or `RETRY`.

JSON

{
  "url": "https://verify.paywithmoon.com/kyc?token=eyJhbGciOiJIUzI1NiJ9.xyz789",
  "status": "NOT_STARTED"
}

400 Error

Validation failed (errors[] lists each offending field) or a domain rule rejected the request ({ message, code }).