Compliance

Retrieve a card

Beta: This endpoint is in beta and may change before general availability.

Retrieves a specific card by its ID. Accepts either the server-generated Card ID (card_*) or the client_card_id of a card created via file upload.

get/v0/cards/{id}

Path parameters

idstring required

The Card ID. Either the server-generated Card ID (card_*) or the client_card_id assigned when the card was created via file upload.

Response

Card object retrieved successfully.

idstring

The server-generated ID of the Card object.

client_card_idstring

Client-provided identifier for the card. Optional: present only for cards created via file upload, and omitted for cards created through the API, which are identified solely by their server-generated ID.

account_idstring

The ID of the Account object.

entity_idstring

The ID of your entity.

status'active' | 'inactive' | 'closed'

Status is system-managed and cannot be set on create; status changes go through the status-transition endpoints.

status_reasonstring

The reason for the card's current status. Empty when the card is active; otherwise populated. Set via the status-transition endpoints.

created_atstring date-time

Creation timestamp.

updated_atstring date-time

Last update timestamp.

metadataMetadata

A set of key-value pairs that can be used to store additional information related to this object.

Example response

{
  "id": "card_xyz123",
  "account_id": "account_xyz123",
  "entity_id": "entity_xyz123",
  "details": {
    "last_four": "1234",
    "replacement_for": "card_xyz123"
  }
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.