SYsynctera
Documents

Create a document

Store a document in the Synctera platform.

post/documents

Request

  • Base URL
    https://api-sandbox.synctera.com/v0
  • URL
    https://api-sandbox.synctera.com/v0/documents
  • Auth
    HTTP bearer

Request body multipart/form-data

batch_idstring

The ID of the batch that the document belongs to

descriptionstring

A description of the attached document

encryption'NOT_REQUIRED' | 'REQUIRED'

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
filestring binary required

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

metadatastring

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.

namestring

A user-friendly name for the document

related_resource_idstring uuid

The ID of the resource related to the document

related_resource_type'ACCOUNT' | 'BUSINESS' | 'CUSTOMER' | 'EDD' | 'INVOICE' | 'REVENUE_STATEMENT'

The type of the resource related to the document

type'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'

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.

Example request

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

Response

Created document representation.

available_versionsinteger[]

All document versions

batch_idstring

The ID of the batch that the document belongs to

creation_timestring date-time

The date and time the resource was created

deletion_reasonstring

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

descriptionstring

A description of the document

encryption'NOT_REQUIRED' | 'REQUIRED'

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
file_namestring

The file name of the document

idstring uuid

The unique identifier for this resource

last_updated_timestring date-time

The date and time the resource was last updated

metadataMetadata

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

namestring

A user-friendly name for the document

related_resource_idstring uuid

The ID of the resource related to the document

related_resource_type'ACCOUNT' | 'BUSINESS' | 'CUSTOMER' | 'EDD' | 'INVOICE' | 'REVENUE_STATEMENT'

The type of the resource related to the document

tenantstring

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

type'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'

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.

versioninteger

Positive integer representing the version of the document

Example response

{
  "available_versions_info": [
    {
      "creation_time": "2010-05-06T12:23:34.321Z",
      "last_updated_time": "2010-05-06T12:23:34.321Z"
    }
  ],
  "creation_time": "2010-05-06T12:23:34.321Z",
  "id": "b01db9c7-78f2-4a99-8aca-1231d32f9b96",
  "last_updated_time": "2010-05-06T12:23:34.321Z",
  "tenant": "abcdef_ghijkl"
}

Changes

No recorded changes to this operation across all 11 revisions of this API.