ALalloy
Documents

Describe a Document Before Uploading

Changed on

The document upload API is a two-step process. First, the metadata for the document is specified, and the API returns a file identifier so the file can be streamed directly to the next endpoint. You’ll need to look for the document_token returned in the response because that is necessary to pass to the next endpoint for streaming the file.

post/entities/{entity_token}/documents

Request

Request body

namestring required
extensionstring required
type'contract' | 'license' | 'passport' | 'utility' | 'other' | 'internal' | 'identification_card' | 'residence_permit' | 'canada_provincial_id' | 'indigenous_card' | 'paystub' | 'bank_statement' | 'w2' | '1099' | '1120' | '1065' | 't1' | 't4' | 'w9' | 'deposited_check' | 'voided_check' | 'social_security_card' | 'h1b' | 'passport_card' | 'credit_report' | 'iso_app' | 'brokerage_statement' | 'lease' | 'document' | 'ucc1' | 'incorporation_certificate' | 'good_standing_certificate' required
notestring
note_author_agent_emailstring

Example request

{
  "name": "license_photo",
  "extension": "jpg",
  "type": "license",
  "note": "This is a license photo",
  "note_author_agent_email": "cool_agent@fakedomain.net"
}

Response

Document

document_tokenstring
type'contract' | 'license' | 'passport' | 'utility' | 'other' | 'internal' | 'identification_card' | 'residence_permit' | 'canada_provincial_id' | 'indigenous_card' | 'paystub' | 'bank_statement' | 'w2' | '1099' | '1120' | '1065' | 't1' | 't4' | 'w9' | 'deposited_check' | 'voided_check' | 'social_security_card' | 'h1b' | 'passport_card' | 'credit_report' | 'iso_app' | 'brokerage_statement' | 'lease' | 'document' | 'ucc1' | 'incorporation_certificate' | 'good_standing_certificate'
namestring
extensionstring
uploadedboolean
timestampnumber
approvedstring
approval_agent_emailstring
approval_timestampnumber

Changes

  • 615aa97a5ddbRevision changes
    • breaking

      removed the enum value 1065.00 of the request property

    • breaking

      removed the enum value 1099.00 of the request property

    • breaking

      removed the enum value 1120.00 of the request property

    • info

      added the new 1065 enum value to the request property

    • info

      added the new 1099 enum value to the request property

    • info

      added the new 1120 enum value to the request property

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status