customField1

string (50)

A property for holding client-defined data. There is no business logic in Helix for a custom field.

customField2

string (50)

A property for holding client-defined data. There is no business logic in Helix for a custom field.

customField3

string (50)

A property for holding client-defined data. There is no business logic in Helix for a custom field.

customField4

string (50)

A property for holding client-defined data. There is no business logic in Helix for a custom field.

customField5

string (50)

A property for holding client-defined data. There is no business logic in Helix for a custom field.

customerId

integer

The Helix-assigned unique ID for the customer who uploaded the document.

documentContent

string (10 MB)

A base64-encoded representation of the actual content of the document.

• NOTE*: Applicable only when calling the /customerDocument/upload route. This property will not be returned by any route. Use RFC 4648-compliant encoding (i.e. no embedded line breaks and = as the padding character). See RFC 4648 for more information.

documentId

integer

The Helix-assigned unique ID of the document.

documentName

string (50)

A caller-specified, user-friendly name for this document. Must have one of the following extensions:

• .jpg
• .jpeg
• .gif
• .png
• .pdf
• .heic(please note that.heicfiles will be converted to.jpeg before we store them in helix)

documentType

enum

The type of document. Possible values:

• DriversLicense
• UtilityBill
• BankStatement
• NameChangeAffidavit
• WrittenStatementOfUnauthorizedDebit
• Unspecified
• VerificationSummary
• DisputeDocumentation
• HoldNotice
• DriversLicenseBack
• PassportFront
• PassportBack
• UnspecifiedIdCardFront
• UnspecifiedIdCardBack
• SelfPortrait
• DBAStatementOfFiling*
• FictitiousBusinessName*
• BusinessLicenseShowingCurrent*
• AttestationDocument*
• CertificateOfPartnership*
• PartnershipAgreement*
• ProofOfAddress*
• ArticlesOfOrganization*
• CertificateOfFormation*
• CertificateOfOrganization*
• SecretaryOfStateRegistration*
• ProofOfGoodStanding*
• CorporateAuthorization*
• EINLetter*
• ArticlesOfIncorporation*
• Charter*
• TrustDocuments*
• CurrentSecretaryOfStateRegistration*
• CourtDocuments*
• TrustCertificate*
• BirthCertificate**
• SocialSecurityCardFront**
• SocialSecurityCardBack**
• SchoolIDFront**
• SchoolIDBack**
• DeathCertificate
• PowerOfAttorney
• ProofOfAuthorization *Values are only used for business customers **Values are only used for minor customers

reasonType

enum

The reason for uploading the document. Possible values:

• NameChange
• AddressChange
• RequestForNewExternalAccount
• Unspecified
• ManualReview
• ReturnOnTransaction
• VerificationSummary
• DisputeDocumentation
• HoldPlaced
• AutomatedReview
• Remediation Document

tag

string (50)

A caller-specified unique identifier for this document.