JUjustifi
Document

Create a Document

Create a reference to a document, and receive a presigned URL for uploading the document

post/entities/document

Request

Headers

Authorizationstring required

the access_token value returned from the JustiFi oauth/token endpoint (be sure to append Bearer before the token)

Request body

descriptionstring
file_namestring required
file_typestring required

the file media type/extension of the file you are uploading. For example, text/plain, application/pdf, image/png

document_type'articles_of_incorporation' | 'balance_sheet' | 'bank_statement' | 'birth_certificate' | 'business_registration' | 'citizenship_card' | 'driver_license' | 'foreign_passport' | 'government_id' | 'nexus_card' | 'passport' | 'profit_and_loss_statement' | 'resident_card' | 'sin_card' | 'ssn_card' | 'status_card' | 'tax_return' | 'voided_check' | 'other' required

The kind of document being uploaded. To provision a business for payments, upload:

  • Financial document (all businesses): voided_check or bank_statement.
  • Business document (Canadian businesses only): articles_of_incorporation or business_registration.
  • Owner identification (Canadian businesses only): one Group 1 and one Group 2 ID per owner.
    • Group 1: passport (Canadian passport), driver_license (Canadian or US state driver's license), government_id (Canadian government-issued ID card), resident_card (Permanent Resident Card), status_card (Certificate of Indian Status).
    • Group 2: nexus_card (NEXUS card), citizenship_card (Canadian citizenship or naturalization card or certificate), foreign_passport, birth_certificate (Canadian birth certificate), sin_card (Social Insurance Number card), ssn_card (Social Security Number card).

balance_sheet, profit_and_loss_statement, tax_return and other are optional.

business_idstring uuid

the business id to associate with this document (one of business id or identity id is required)

identity_idstring uuid

the identity id to associate with this document (one of business id or identity id is required)

metadataobject

any useful information you'd like to store alongside this document

Example request

{
  "description": "My Document",
  "file_name": "the_file_name",
  "file_type": "application/pdf",
  "document_type": "balance_sheet",
  "business_id": "biz_abc123",
  "identity_id": "idty_abc123",
  "metadata": {
    "my_id": "123"
  }
}

Response

Document was created and presigned successfully

idstring uuid

the object id, also found in the data object

typestring

the object type, or array of objects

page_infounknown

Example response

{
  "id": "prefix_xyz (same as id of data object)",
  "type": "document",
  "data": {
    "id": "doc_abc123",
    "platform_account_id": "acc_123xyz",
    "description": "My Document",
    "file_name": "my_document",
    "file_type": "pdf",
    "document_type": "balance_sheet",
    "business_id": "biz_abc123",
    "identity_id": "idty_abc123",
    "presigned_url": "https://test.test/doc_abc123/file_name.pdf",
    "metadata": {
      "language": "english",
      "social_network": "@person"
    },
    "created_at": "2021-01-01T12:00:00Z",
    "updated_at": "2021-01-01T12:00:00Z"
  }
}

Changes

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