Run a submission pre-flight check

Runs the instant submission checks without starting verification, so you can fix problems before calling Run business verification. It evaluates the submission as a whole, using the documents uploaded so far. For example, one check confirms the applicant is authorized to act on behalf of the business; if it fails, you can ask the applicant for the missing legal documents now instead of sending a request for information (RFI) after the full analysis.

NOTE

Pre-flight needs a pending or pending_rfi submission and a policy with pre-flight checks enabled; otherwise the request returns 422 with Submission status must be pending or pending_rfi or Policy has no instant submission checks enabled. Contact support@niva.co to enable pre-flight checks on your policy.

Acting on the results

Pre-flight is advisory. A validation_status other than valid does not prevent you from running the submission; it tells you what the full analysis is likely to find, so you can decide whether to resolve it first. Call it at a point in your onboarding flow where a short wait is acceptable, for example right after the applicant finishes uploading documents.

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢201Created

application/json

Success

Bodyapplication/json

Examples

A check failedA check could not be evaluatedA check had not finished in timeThe submission is ready

{
  "id": "sub_3ZMd9KJnvAdYt4mOyW7YQRAp",
  "validation_status": "fail",
  "validation_errors": [
    {
      "type": "fail",
      "error": "applicant_not_legal_rep",
      "error_message": "Applicant is not a legal representative of the company.",
      "display_message": "Applicant has not proven they are a legal representative. Please upload documentation to prove you are a legal representative."
    }
  ]
}

🟠401Unauthorized

🟠404Not Found

🟠422Unprocessable Content

🔴500Internal Server Error

Run a submission pre-flight check

Acting on the results#

Request

Request Code Samples

Responses

Acting on the results