Identity Verification Add Document (identity_verification_document_add)

Adds document information such as issuing country, id and type for identity verification processes.

Auth Scope(s): admin

identity_verification_document_add(document_number: str, document_type: str, issuing_country: str, passthrough: Optional[Any] = None, req_id: Optional[int] = None) → int
Parameters:
  • document_number (str) – The identification number of the document.
  • document_type (str) – The type of the document based on provided issuing_country (can obtained from residence_list call).
  • issuing_country (str) – 2-letter country code (can obtained from residence_list call).
  • 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.identity_verification_document_add(
    document_number='12345678912'
    document_type='nin_slip'
    issuing_country='ng'
)

See also