PATCH
/
document
/
{id}
Update a Document
curl --request PATCH \
  --url https://api.treasuryprime.com/document/{id} \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "OR Drivers License"
}'
{
  "bankdata": {},
  "created_at": "2021-03-25T21:31:50Z",
  "fields": {
    "date_of_birth": "1980-03-15"
  },
  "file_id": "file_567890",
  "id": "doc_123456",
  "name": "OR Drivers License",
  "type": "drivers_license",
  "updated_at": "2021-03-25T21:31:50Z",
  "userdata": {}
}

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

​
id
string
required

Unique identifier for object

Body

application/json

The document to update

​
bankdata
object

Optional arbitrary data the bank can attach to the object

​
fields
object

Object representing the data encoded in the Document

​
name
string

A descriptive name for the document

​
type
string

One of: drivers_license, military_id, passport, state_id, other

​
userdata
object

Optional arbitrary data the user can attach to the object

Response

200 - application/json

The document updated

​
bank_id
string

ID of the bank with which the object is associated

​
bankdata
object

Optional arbitrary data the bank can attach to the object

​
description
string
deprecated

Description (deprecated)

​
fields
object

Object representing the data encoded in the Document

​
file_id
string

The unique ID for an attached File

​
id
string

Unique identifier for object

​
name
string

A descriptive name for the document

​
org_id
string

ID of the organization with which the object is associated

​
type
string

One of: drivers_license, military_id, passport, state_id, other

​
userdata
object

Optional arbitrary data the user can attach to the object