Document Upload (document_upload)¶

Request KYC information from client

Auth Scope(s): admin

document_upload(document_format: str, document_type: str, expected_checksum: str, file_size: int, document_id: Optional[str] = None, document_issuing_country: Optional[str] = None, expiration_date: Optional[str] = None, lifetime_valid: Optional[int] = None, page_type: Optional[str] = None, proof_of_ownership=None, passthrough: Optional[Any] = None, req_id: Optional[int] = None) → int¶

Parameters:	document_format (str) – Document file format document_type (str) – Document type expected_checksum (str) – The checksum of the file to be uploaded file_size (int) – Document size (should be less than 10MB) document_id (Optional[str]) – [Optional] Document ID (required for Passport, Proof of ID and Driver’s License) document_issuing_country (Optional[str]) – [Optional] 2-letter country code expiration_date (Optional[str]) – [Optional] Document expiration date (required for Passport, Proof of ID and Driver’s License) lifetime_valid (Optional[int]) – [Optional] Boolean value that indicates whether this document is lifetime valid (only applies to POI document types, cancels out the expiration_date given if any) page_type (Optional[str]) – [Optional] To determine document side proof_of_ownership – [Optional] It contains info about the proof of ownership being uploaded (mandatory for proof_of_ownership document type) passthrough (Optional[Any]) – [Optional] Used to pass data through the websocket, which may be retrieved via the echo_req output field. req_id (Optional[int]) – [Optional] Used to map request to response.
Returns:	req_id
Return type:	int

Example¶

binary.api.document_upload(
    document_format='JPG'
    document_type='bankstatement'
    expected_checksum='1a79a4d60de6718e8e5b326e338ae533'
    file_size=12345
)