ALalloy
Documents

Update Document Metadata

Changed on

If you want to mark a document as “approved” or “denied” (if you have a document review process), or just change the name or type of a document, you can do so with the PATCH endpoint.

patch/entities/{entity_token}/documents/{document_token}

Request

Request body

approvedboolean required
typestring required
approval_agent_emailstring required
namestring required

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
    • 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