Get Card - V1

Get Card - Get information on registered cards

Get information on a specific enrolled card

get

https://calm.sandbox.verygoodsecurity.apphttps://calm.live.verygoodsecurity.app

/cards/{card_id}

Returns information of enrolled card with the most up-to-date card information available from issuing banks and all VGS Account Updater capabilities.

Required scopes

This endpoint requires the following scopes:

• : Grants read access to cards

Authorizations

OAuth2

OAuth2clientCredentialsRequired

Token URL:

Path parameters

card_idstringRequired

ID of the card to fetch

Example: CRDuVQCsenqj6dbHFQq9gen2EPattern: ^CRD.*$

Responses

200

Enroll card API response.

application/json

404

Not found. Possible error codes:

• card-not-found

application/json

500

Internal Server Error

application/json

default

Enroll card API response.

application/json

get

/cards/{card_id}

HTTPcURLJavaScriptPython

GET /cards/{card_id} HTTP/1.1
Host: calm.sandbox.verygoodsecurity.app
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "data": {
    "name": "John Doe",
    "number": "5573495XTjZP21V7312",
    "exp_month": 7,
    "exp_year": 24,
    "billing_address": {
      "name": "John Doe",
      "company": "John Doe Company",
      "address1": "555 Example St",
      "address2": "M13 9PL",
      "city": "New York",
      "region": "NY",
      "country": "US",
      "postal_code": "12301",
      "phone": "[phone]"
    },
    "capabilities": [
      "ACCOUNT_UPDATER"
    ],
    "id": "CRDuVQCsenqj6dbHFQq9gen2E",
    "created_at": "2019-05-15T12:30:45Z",
    "updated_at": "2019-05-15T12:30:45Z",
    "state": "enrolled",
    "event": "au_card.enrolled"
  }
}

The following cURL command will get your card information from the VGS Account Updater.

cURL

curl --request GET https://calm.<ENVIRONMENT>.verygoodsecurity.app/cards/CRDuVQCsenqj6dbHFQq9gen2E \
-x https://<CREDENTIALS>@<VAULT_ID>.<ENVIRONMENT>.verygoodproxy.com:8443 -k \
-H "Content-type: application/json" \
-H "Authorization: Bearer ${VGS_ACCESS_TOKEN}"

VGS Account Updater returns a Card object in response to your API request.

Response (application/json)

{
  "data": {
    "id": "CRDuVQCsenqj6dbHFQq9gen2E",
    "name": "John Doe",
    "number": "tok_svzgzzX8SDJMRjk93GVKG6b",
    "exp_month": 7,
    "exp_year": 24,
    "capabilities": [
      "ACCOUNT_UPDATER"
    ],
    "created_at": "2019-05-15T12:30:45Z",
    "updated_at": "2019-05-15T12:30:45Z",
    "state": "enrolled",
    "event": "au_card.enrolled"
  }
}