Retrieve tokenized data for reveal

GET 
/v1/vault/show

Retrieves stored document or card details.

Request

Query Parameters

type ShowTokensTyperequired

Possible values: [document, card]

The type of data to retrieve

documentType DocumentType

Possible values: [ssn, id_card, license, passport]

The type of document to retrieve (required when type=document)

cardId string

The card ID to retrieve details for (required when type=card)

fields CardField[]

Possible values: [pan, cvv, expiry]

Card fields to retrieve. Defaults to all fields when not specified.

type anyrequired

The type of data to retrieve

documentType any

The type of document to retrieve (required when type=document)

cardId any

The card ID to retrieve details for (required when type=card)

fields any

Card fields to retrieve. Defaults to all fields when not specified.

Responses

200

Token data retrieved successfully.

application/json

Schema

Schema

traceId string
message string

data

object

documentSsn string

Tokenized SSN value

documentIdCard string

Tokenized ID card value

documentLicense string

Tokenized driver license value

documentPassport string

Tokenized passport value

card

object

Card details retrieved from the card provider

pan string

Card number (PAN) - tokenized

cvv string

Card security code (CVV) - tokenized

expiryDate string

Card expiration date in MMYY format - tokenized

Example (from schema)

{
  "traceId": "string",
  "message": "string",
  "data": {
    "documentSsn": "string",
    "documentIdCard": "string",
    "documentLicense": "string",
    "documentPassport": "string",
    "card": {
      "pan": "tok_xxxxx",
      "cvv": "tok_xxxxx",
      "expiryDate": "tok_xxxxx"
    }
  }
}

400

Invalid request payload. This can happen if required fields are missing or have invalid formats.

application/json

Schema

Schema

traceId string
message string

Example (from schema)

{
  "traceId": "string",
  "message": "string"
}

403

The API key is invalid or the client does not have sufficient permissions.

application/json

Schema

Schema

traceId string
message string

Example (from schema)

{
  "traceId": "string",
  "message": "string"
}

404

One of the specified resources was not found. Does not apply for empty result set.

application/json

Schema

Schema

traceId string
message string

Example (from schema)

{
  "traceId": "string",
  "message": "string"
}

Loading...