Sign in

v5

latestOpenAPI 3.1.02026-07-262421791.5 MB
card-order

Retrieve card order requirements

Retrieves all card requirements for a cardOrderId. A valid card order needs all its requirements status to be COMPLETED.

The type of requirements are:

  • PIN (optional): Set a PIN on a virtual or physical card order. Contact the team if you need this feature.
  • VERIFICATION: Verify your customer by providing KYC evidences. Refer to the KYC guide.
  • ADDRESS: Provide a valid address for your card order. Refer to address validation.

A requirement status has the following values:

  • NOT_INITIATED
  • NEEDS_ACTION
  • PENDING
  • COMPLETED
  • FAILED
get/v3/spend/profiles/{profileId}/card-orders/{cardOrderId}/requirements

Path parameters

profileIdinteger required

The profile ID (personal or business).

cardOrderIdinteger required

The card order ID.

Headers

X-External-Correlation-Idstring uuid

Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. Learn more.

Response

OK - Successfully retrieved card order requirements.

Example response

{
  "requirements": [
    {
      "type": "PIN",
      "status": "NOT_INITIATED"
    }
  ]
}