Store tokenized document

POST 
/v1/vault/collect

Stores a tokenized document value on for the user.

Request

application/json

Body

required

The tokenized document data to store

documentType DocumentType (string)required

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

documentToken stringrequired

The tokenized document value to store

Responses

201

Document token was successfully stored.

application/json

Schema

Schema

traceId string
message string

data

object

userId stringrequired

The unique identifier of the user

documentType DocumentType (string)required

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

The type of document that was stored

Example (from schema)

{
  "traceId": "string",
  "message": "string",
  "data": {
    "userId": "123e4567-e89b-12d3-a456-426614174000",
    "documentType": "ssn"
  }
}

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...