Rerun validations

Developing

Production

https://api.niva.co/v1

PUT

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

Re-run validations for an existing document. You can update any custom validation inputs initially used when uploading the document.

Note: you can specify both the Niva document ID or the external ID to refer to the document. External IDs can be non-unique, so the response will return an array of document objects.

Request

Authorization

Add parameter in header

apiKey

Example:

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

Path Params

Header Params

Body Params application/json

Example

{
    "validation_inputs": {
        "name": "Juan Perez"
    }
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PUT 'https://api.niva.co/v1/submissions/sub_12345AbCdE/documents/doc_xYzEa982Abe/run_validations' \
--header 'Accept-Language;' \
--header 'apiKey: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
    "validation_inputs": {
        "name": "Juan Perez"
    }
}'

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

Download document file

Get company with ID