Upload document
Production
https://api.niva.co/v1
Production
https://api.niva.co/v1
POST
https://api.niva.co/v1
Identify the document
country_code, document_type and document_subtype (the subtype may be omitted for photo_identification and address_proof, where Niva detects it). The pairs each market accepts are listed under Supported document types; country_code must be the submission's market, except a Mexican photo_identification, which takes the issuing country (e.g. us for a US passport). An other / other document also needs document_name.file, or several files of the same document as files (Niva merges them into one PDF); exactly one of the two. PDF, JPG and PNG are accepted, up to 100 MB in total.TIP
Document validation
other for legibility, completeness and type before responding, so the response carries the result in validation_status, validation_errors and the extracted data. A document that fails a blocking check is still returned with 201. With persist_invalid=false, Niva archives a document that fails a blocking check and sends document.deleted; the response still contains that document. If validation takes longer than about 100 seconds the request fails with 500, but the document is kept and validation continues: do not upload it again. Wait for the document.validated webhook or find the document with List documents by external_id.Custom validation inputs
validation_inputs[name]; to require the holder to be a person or a company, send validation_inputs[entity_type]. Both only affect the checks your policy runs at upload, by default name checks on Mexican proof of address, bank statements, CSF (Constancia de Situación Fiscal) and INE (voter ID), and on ID documents, tax registrations and bank statements in Brazil, Chile and Colombia.Merging
parent_document_id. When complementary ID sides are combined, the response instead contains the combined document. Always use the id returned by the upload response. See Merging documents.Errors
| 422 response | When |
|---|---|
document_subtype: is not supported for <market> "<type>" documents | The pair is not in the market's list |
country_code: must match the submission's market | A non-Mexican document with another market's code |
document_name: is required | An other document without a name |
file, files: are missing, exactly one parameter must be provided | Neither file nor files was sent |
Invalid file type / File is too large. Maximum allowed 100MB | File rules |
errors, an array of strings or {field, message} objects. Unsupported file formats and oversized files instead return a single error string; see the response examples.Request
Path Params
Header Params
Body Params multipart/form-data