Browse the docs

Request cardholder KYC check

POST /v1/api-gateway/cardholder/{cardholder_id}/check

Submits the documents already uploaded for this cardholder to the KYC provider for review and moves the cardholder KYC to PENDING. A KYC session is started automatically when the cardholder has none yet. Read the outcome with GET /cardholder/{end_customer_id}/kyc.

Request

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

Path parameters

Field	Type	Description
`cardholder_id` required	string, uuid	The Moon cardholder id (`id`, a UUID), not your `end_customer_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/v1/api-gateway/cardholder/3f5b1c2e-8d4a-4b6f-9e2a-1c7d8e9f0a1b/check' \
     --header 'x-api-key: YOUR_API_KEY'

Responses

200 Success

Documents submitted for review; the verification status is now PENDING.

Field	Type	Description
`status` required	string	Verification status after submission. Always `PENDING`; read the outcome later with the corresponding KYC/KYB status endpoint.

JSON

{
  "status": "PENDING"
}

400 Error

Validation failed, or the cardholder has no KYC session that can be submitted (KYC_NOT_INITIATED, APPLICANT_NOT_FOUND).