Skip to main content
Retrieve or update a given card’s Personal Identification Number (PIN).

Retrieve a card’s PIN

GET /v2/cards/{cardId}/pin

Request

Use this request to retrieve the PIN for a given card.

Path parameters

cardId
string
required
The ID of the card that you want to retrieve the PIN for.Allowable values: An existing cardId (≤ 36 characters)

Query parameters

accountId
string
required
The ID of the account associated with the card.Allowable values: An existing cardId (≤ 36 characters)
personId
string
required
The ID of the person who owns the card.Allowable values: An existing personId (≤ 36 characters)
cardholderVerificationMethod
string
required
The method that was used to verify the identity of the cardholder.Allowable values: BIOMETRIC_FACE, BIOMETRIC_FINGERPRINT, LOGIN

Response

If your request is successful, you’ll receive a 200 response containing the pin.
For more detailed information about this request and its response, see the API reference.

Update a card’s PIN

PUT /v2/cards/{cardId}/pin

Request

Use this request to update the PIN of a card on a given account where an accountId and cardId are provided.

Path parameters

cardId
string
required
The ID of the card that you want to update the PIN for. You can get the cardId when you view card details.Allowable values: An existing cardId (≤ 36 characters)

Query parameters

accountId
string
required
The ID of the account associated with the card.Allowable values: An existing accountId (≤ 36 characters)
personId
string
required
The ID of the person that the card belongs to.Allowable values: An existing personId (≤ 36 characters)

Request body schema

pin
string
The new card PIN. If not provided, we’ll randomly generate one for you.Allowable values: 4 characters (^\d+$)

Response

If your request is successful, you’ll receive a 200 response.
For more detailed information about this request and its response, see the API reference.