POST
/
documents
Create a document
curl --request POST \
  --url https://api-sandbox.synctera.com/v0/documents \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form 'description=<string>' \
  --form encryption=NOT_REQUIRED \
  --form 'metadata={"key": "value"}' \
  --form 'name=<string>' \
  --form related_resource_id=3c90c3cc-0d44-4b50-8888-8dd25736052a \
  --form related_resource_type=ACCOUNT \
  --form type=ADDRESS_VERIFICATION \
  --form file=@example-file
{
  "available_versions": [
    123
  ],
  "available_versions_info": [
    {
      "creation_time": "2010-05-06T12:23:34.321Z",
      "file_name": "<string>",
      "last_updated_time": "2010-05-06T12:23:34.321Z",
      "version": 123
    }
  ],
  "creation_time": "2010-05-06T12:23:34.321Z",
  "deletion_reason": "<string>",
  "description": "<string>",
  "encryption": "NOT_REQUIRED",
  "file_name": "<string>",
  "id": "b01db9c7-78f2-4a99-8aca-1231d32f9b96",
  "last_updated_time": "2010-05-06T12:23:34.321Z",
  "metadata": {},
  "name": "<string>",
  "related_resource_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "related_resource_type": "ACCOUNT",
  "tenant": "abcdef_ghijkl",
  "type": "ADDRESS_VERIFICATION",
  "version": 123
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

multipart/form-data
​
file
file
required

The file contents. The maximum file size is 32 MB.

​
description
string

A description of the attached document

​
encryption
enum<string>

Whether the file will be encrypted by the Synctera platform before storing. All documents containing PII must be encrypted.

Creating and retrieving encrypted documents requires documents_encrypted:write and documents_encrypted:read permissions, respectively.

If encryption is not specified, a default will be chosen based on the document type. See the following table.

Document types with a default of REQUIRED must be encrypted. It is an error to explicitly set encryption to NOT_REQUIRED for these document types.

Document types with a default of NOT_REQUIRED may optionally be encrypted by explicitly setting encryption to REQUIRED.

Document TypeDefault Encryption
ADDRESS_VERIFICATIONREQUIRED
APPLICATION_DOCUMENTATIONNOT_REQUIRED
BILLING_DOCUMENTNOT_REQUIRED
CHECK_IMAGEREQUIRED
COMPANY_PROFILE_DOCUMENTNOT_REQUIRED
COMPLIANCE_REPORTREQUIRED
DATE_OF_BIRTH_VERIFICATIONREQUIRED
FINANCIAL_FILEREQUIRED
IDENTITY_DOCUMENTATIONREQUIRED
INCOME_DOCUMENTATIONREQUIRED
STATEMENTNOT_REQUIRED
STATEMENT_DISCLOSURENOT_REQUIRED
TAX_FORMREQUIRED
TERMS_OF_SERVICENOT_REQUIRED
Available options:
NOT_REQUIRED,
REQUIRED
​
metadata
string

Optional field to store additional information about the resource. Intended to be used by the integrator to store non-sensitive data. Since some API clients have trouble formatting multipart/form-data properties that are objects, this property is defined as a string formatted to contain the marshalled JSON object.

Example:

"{\"key\": \"value\"}"

​
name
string

A user-friendly name for the document

​
related_resource_id
string<uuid>

The ID of the resource related to the document

​
related_resource_type
enum<string>

The type of the resource related to the document

Available options:
ACCOUNT,
BUSINESS,
CUSTOMER,
EDD,
INVOICE,
REVENUE_STATEMENT
​
type
enum<string>

The type of the document. The type can be changed after the document is created, except that a non-encrypted document cannot be changed to a type that requires encryption.

Available options:
ADDRESS_VERIFICATION,
APPLICATION_DOCUMENTATION,
BILLING_DOCUMENT,
CHECK_IMAGE,
COMPANY_PROFILE_DOCUMENT,
COMPLIANCE_REPORT,
DATE_OF_BIRTH_VERIFICATION,
FINANCIAL_FILE,
IDENTITY_DOCUMENTATION,
INCOME_DOCUMENTATION,
STATEMENT,
STATEMENT_DISCLOSURE,
TAX_FORM,
TERMS_OF_SERVICE

Response

Created document representation.

​
available_versions
integer[]

All document versions

​
available_versions_info
object[]

Metadata of all document versions

​
creation_time
string<date-time>

The date and time the resource was created

Example:

"2010-05-06T12:23:34.321Z"

​
deletion_reason
string

An explanation why the file was deleted. You must set a document's deletion_reason before deleting it.

​
description
string

A description of the document

​
encryption
enum<string>

Whether the file will be encrypted by the Synctera platform before storing. All documents containing PII must be encrypted.

Creating and retrieving encrypted documents requires documents_encrypted:write and documents_encrypted:read permissions, respectively.

If encryption is not specified, a default will be chosen based on the document type. See the following table.

Document types with a default of REQUIRED must be encrypted. It is an error to explicitly set encryption to NOT_REQUIRED for these document types.

Document types with a default of NOT_REQUIRED may optionally be encrypted by explicitly setting encryption to REQUIRED.

Document TypeDefault Encryption
ADDRESS_VERIFICATIONREQUIRED
APPLICATION_DOCUMENTATIONNOT_REQUIRED
BILLING_DOCUMENTNOT_REQUIRED
CHECK_IMAGEREQUIRED
COMPANY_PROFILE_DOCUMENTNOT_REQUIRED
COMPLIANCE_REPORTREQUIRED
DATE_OF_BIRTH_VERIFICATIONREQUIRED
FINANCIAL_FILEREQUIRED
IDENTITY_DOCUMENTATIONREQUIRED
INCOME_DOCUMENTATIONREQUIRED
STATEMENTNOT_REQUIRED
STATEMENT_DISCLOSURENOT_REQUIRED
TAX_FORMREQUIRED
TERMS_OF_SERVICENOT_REQUIRED
Available options:
NOT_REQUIRED,
REQUIRED
​
file_name
string

The file name of the document

​
id
string<uuid>

The unique identifier for this resource

Example:

"b01db9c7-78f2-4a99-8aca-1231d32f9b96"

​
last_updated_time
string<date-time>

The date and time the resource was last updated

Example:

"2010-05-06T12:23:34.321Z"

​
metadata
object

Optional field to store additional information about the resource. Intended to be used by the integrator to store non-sensitive data.

​
name
string

A user-friendly name for the document

​
related_resource_id
string<uuid>

The ID of the resource related to the document

​
related_resource_type
enum<string>

The type of the resource related to the document

Available options:
ACCOUNT,
BUSINESS,
CUSTOMER,
EDD,
INVOICE,
REVENUE_STATEMENT
​
tenant
string

The id of the tenant containing the resource. This is relevant for Fintechs that have multiple workspaces.

Example:

"abcdef_ghijkl"

​
type
enum<string>

The type of the document. The type can be changed after the document is created, except that a non-encrypted document cannot be changed to a type that requires encryption.

Available options:
ADDRESS_VERIFICATION,
APPLICATION_DOCUMENTATION,
BILLING_DOCUMENT,
CHECK_IMAGE,
COMPANY_PROFILE_DOCUMENT,
COMPLIANCE_REPORT,
DATE_OF_BIRTH_VERIFICATION,
FINANCIAL_FILE,
IDENTITY_DOCUMENTATION,
INCOME_DOCUMENTATION,
STATEMENT,
STATEMENT_DISCLOSURE,
TAX_FORM,
TERMS_OF_SERVICE
​
version
integer

Positive integer representing the version of the document