Sign in
Document

Update a Document

patch/document/{id}

Path parameters

idstring required

Unique identifier for object

Unique identifier for object

Request body

bankdataobject

Optional arbitrary data the bank can attach to the object

fieldsobject

Object representing the data encoded in the Document

namestring

A descriptive name for the document

typestring

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

userdataobject

Optional arbitrary data the user can attach to the object

Response

The document updated

bank_idstring

ID of the bank with which the object is associated

bankdataobject

Optional arbitrary data the bank can attach to the object

descriptionstring

Description (deprecated)

fieldsobject

Object representing the data encoded in the Document

file_idstring

The unique ID for an attached File

idstring

Unique identifier for object

namestring

A descriptive name for the document

org_idstring

ID of the organization with which the object is associated

typestring

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

userdataobject

Optional arbitrary data the user can attach to the object

Changes

No recorded changes to this endpoint across all 1 revision of this API.