Skip to main content
PUT
Send a document

Authorizations

Authorization
string
header
required

Authorization: Bearer <key>. Sandbox keys start with mgw_test_ and live keys start with mgw_live_. Each key works only in its own environment, and a live key works only from the IP addresses or ranges registered for it.

Path Parameters

id
string
required

The application's id.

Pattern: ^app_[a-z2-7]{20}$
type
enum<string>
required

Which of the four documents. photo: a passport photograph. government_id: a government-issued ID. utility_bill: a utility bill, for the address. signature: a specimen of the customer's signature. New values can be added: handle an unrecognised value with a safe default.

Available options:
photo,
government_id,
utility_bill,
signature

Body

The file itself.

The body is of type file.

Response

The document, as the broker has it.

One document of an application, as the broker has it. The gateway keeps no copy of the file.

object
string
required
Allowed value: "document"
application
string
required

The application's id.

Example:

"app_3rbw6yq2kd5mz7tcxf4n"

type
enum<string>
required

photo: a passport photograph. government_id: a government-issued ID. utility_bill: a utility bill, for the address. signature: a specimen of the customer's signature. New values can be added: handle an unrecognised value with a safe default.

Available options:
photo,
government_id,
utility_bill,
signature
state
enum<string>
required

delivered: the broker has the file. It doesn't mean the broker's staff have verified it. New values can be added: handle an unrecognised value with a safe default.

Available options:
delivered
created_at
string<date-time>
required

When the document was first sent, in UTC.

updated_at
string<date-time>
required

When its state last changed, in UTC.