Get submission checks

Production

https://api.niva.co/v1

GET

/submissions/{submission_id}/checks

Returns the completed checks of a processed submission with their outcome: pass, fail, warn (a red flag that did not fail the check) or unverified (not enough information to decide). Which checks run is set by the submission's policy; skipped and unfinished checks are not returned.

Returns 400 Submission has not completed processing while the submission is still processing or has not been run yet. submission_id accepts the submission ID (sub_…) or your external_id.

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/sub_3ZMd9KJnvAdYt4mOyW7YQRAp/checks' \
--header 'Accept-Language: en' \
--header 'apiKey: <api-key>'

Responses

🟢200OK

application/json

Success

Bodyapplication/json

Example

[
  {
    "name": "legal_existence",
    "outcome": "pass",
    "message": "Check passed successfully"
  },
  {
    "name": "applicant_authorization",
    "outcome": "pass",
    "message": "Check passed successfully"
  },
  {
    "name": "watchlists",
    "outcome": "warn",
    "message": "A possible watchlist match needs review: OFAC SDN, 72% name similarity."
  }
]

🟠400Bad Request

🟠401Unauthorized

🟠404Not Found

🔴500Internal Server Error

Run business verification

Delete submission