Initiate account holder document upload

Account Holder Token

uuid
required
Globally unique identifier for the account holder.

Document Type

string
enum
required
The type of document to upload.
EIN_LETTER, TAX_RETURN, OPERATING_AGREEMENT, CERTIFICATE_OF_FORMATION, DRIVERS_LICENSE, PASSPORT, PASSPORT_CARD, CERTIFICATE_OF_GOOD_STANDING, ARTICLES_OF_INCORPORATION, ARTICLES_OF_ORGANIZATION, BYLAWS, GOVERNMENT_BUSINESS_LICENSE, PARTNERSHIP_AGREEMENTS, SS4_FORM, BANK_STATEMENT, UTILITY_BILL_STATEMENT, SSN_CARD, ITIN_LETTER, FINCEN_BOI_REPORT

Entity Token

uuid
required
Globally unique identifier for the entity.

HTTP Response Codes

201 OK

object
Describes the document and the required document image uploads required to re-run KYC

• token
  • uuid
  • required
    Globally unique identifier for the document.
• account_holder_token
  • uuid
  • required
    Globally unique identifier for the account holder.
• document_type
  • string
  • enum
  • required
    Type of documentation to be submitted for verification of an account holder
    DRIVERS_LICENSE, PASSPORT, PASSPORT_CARD, EIN_LETTER, TAX_RETURN, OPERATING_AGREEMENT, CERTIFICATE_OF_FORMATION, CERTIFICATE_OF_GOOD_STANDING, ARTICLES_OF_INCORPORATION, ARTICLES_OF_ORGANIZATION, BYLAWS, GOVERNMENT_BUSINESS_LICENSE, PARTNERSHIP_AGREEMENT, SS4_FORM, BANK_STATEMENT, UTILITY_BILL_STATEMENT, SSN_CARD, ITIN_LETTER, FINCEN_BOI_REPORT
• entity_token
  • uuid
  • required
    Globally unique identifier for an entity.
• required_document_uploads
  • array of objects
  • required
    Represents a single image of the document to upload.

Required Document Uploads

• object
  Represents a single image of the document to upload.
  • image_type
    • string
    • enum
    • required
      Type of image to upload.
      FRONT, BACK
  • status
    • string
    • enum
    • required
      Status of an account holder's document upload.
      ACCEPTED, REJECTED, PENDING_UPLOAD, UPLOADED, PARTIAL_APPROVAL
  • status_reasons
    • array of objects
    • required
      Reasons for document image upload status. DOCUMENT_MISSING_REQUIRED_DATA, DOCUMENT_UPLOAD_TOO_BLURRY, FILE_SIZE_TOO_LARGE, INVALID_DOCUMENT_TYPE, INVALID_DOCUMENT_UPLOAD, INVALID_ENTITY, DOCUMENT_EXPIRED, DOCUMENT_ISSUED_GREATER_THAN_30_DAYS, DOCUMENT_TYPE_NOT_SUPPORTED, UNKNOWN_FAILURE_REASON, UNKNOWN_ERROR
  • upload_url
    • string
    • required
      URL to upload document image to. Note that the upload URLs expire after 7 days. If an upload URL expires, you can refresh the URLs by retrieving the document upload from GET /account_holders/{account_holder_token}/documents.
  • token
    • uuid
    • required
      Globally unique identifier for the document upload.
  • accepted_entity_status_reasons
    • array of strings
    • required
      A list of status reasons associated with a KYB account holder that have been satisfied by the document upload.
  • rejected_entity_status_reasons
    • array of strings
    • required
      A list of status reasons associated with a KYB account holder that have not been satisfied by the document upload.
  • created
    • date-time
    • required
      When the document upload was created.
  • updated
    • date-time
    • required
      When the document upload was last updated.

HTTP Error Codes

• 400
  A parameter in the query given in the request does not match the valid queries for the endpoint.
• 401
  User has not been authenticated. Invalid or missing API key.
• 409
  The request could not be completed due to a conflict with the current state of the target resource.
• 429
  Client has exceeded the number of allowed requests in a given time period.