Update a card's PIN beta

Updates the PIN of a card on a given account where an accountId and cardId are provided.

SecurityCommonAuth
Request
path Parameters
cardId
required
string <uuid> <= 36 characters

The ID of the card to work with.

Example: e9293471-5eb3-4dbc-916c-dbaf9e2deefd
query Parameters
accountId
required
string

The ID of the account to work with.

Example: accountId=F50091
personId
required
string <uuid> <= 36 characters

The ID of the person to work with.

Example: personId=775596ae-2624-40af-a9dc-9756110a4a04
Request Body schema: application/json

Body

pin
string = 4 characters ^\d+$

The new card PIN. If not provided, we'll randomly generate one for you.

cardholderVerificationMethod
string

The supplemental method used to verify the cardholder’s identity before revealing the card’s PIN.

Enum: "BIOMETRIC_FACE" "BIOMETRIC_FINGERPRINT" "LOGIN"
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

405

Method Not Allowed

415

Unsupported Media Type

422

Unable to process the request

429

Too Many Requests

500

Internal Server Error

put/cards/{cardId}/pin
Request samples
application/json
{
  • "pin": "stri",
  • "cardholderVerificationMethod": "BIOMETRIC_FACE"
}
Response samples
application/json
{
  • "success": true,
  • "pin": "stri"
}