Get document

Production

https://api.niva.co/v1

GET

/submissions/{submission_id}/documents/{document_id}

Fetch extracted information for a single document

Request

Authorization

Add parameter in header

apiKey

Example:

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

Path Params

Header Params

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location 'https://api.niva.co/v1/submissions//documents/' \
--header 'Accept-Language;' \
--header 'apiKey: <api-key>'

Responses

🟢200Document found

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"
}

🟠404Not Found

Upload document for submission

Delete document