List documents

Production

https://api.niva.co/v1

GET

public/submissions/{submission_token}/documents

Fetch documents for a submission, using your public API token and expiring submission token. You can filter the returns documents by type, document_name or external_id.

Request

Authorization

Add parameter in header

apiKey

Example:

apiKey: ********************

Path Params

Query Params

Header Params

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location 'https://api.niva.co/v1public/submissions//documents?type=mx_acta_constitutiva&document_name=undefined&external_id=undefined' \
--header 'Accept-Language;' \
--header 'apiKey: <api-key>'

Responses

🟢200Success

application/json

Bodyapplication/json

Example

[
    {
        "id": "string",
        "status": "pending",
        "validation_status": "incomplete",
        "type": "mx_acta_constitutiva",
        "file": {
            "name": "string",
            "byte_size": 0
        },
        "source": "user",
        "data": {},
        "validation_errors": [
            {
                "type": "warn",
                "error": "illegible",
                "error_message": "Document is blank",
                "display_message": "Document is not the correct type. Please upload the correct document."
            }
        ],
        "uploaded_at": "2019-08-24T14:15:22.123Z",
        "external_id": "string",
        "document_name": "string"
    }
]

Public Documents API

Upload document