Initiate Non-Document Verification

Initiates a specific non-document verification check (e.g., Brazil CPF, Nigeria NIN, Nigeria BVN) for an existing applicant. Requires the specific identifier (CPF, NIN, or BVN) in the request body. The API checks if the verification type is supported for the applicant’s country and enabled for the organization before proceeding. Results include the final status (verified or failed) and data returned from the verification source.

POST /api/v4/nondoc/{applicant_id}/verify

cURL

brazil_cpf

curl --request POST \
  --url https://api.dataspike.io/api/v4/nondoc/{applicant_id}/verify \
  --header 'Content-Type: application/json' \
  --header 'ds-api-token: <api-key>' \
  --data '
{
  "verification_type": "NONDOC_BRAZIL_CPF_BASIC",
  "request_data": {
    "cpf\"": "11122233344"
  }
}
'

200

verified_nin_example

{
  "request_id": "01900000-0001-7000-8000-000000000001",
  "status": "verified",
  "verification_type": "NONDOC_NIGERIA_NIN",
  "country_code": "NG",
  "response_data": {
    "name": {
      "name": "Jane Anuoluwapo Doe",
      "last_name": "Doe",
      "first_name": "Jane",
      "patronymic": "Anuoluwapo"
    },
    "photo": "base64encodedstring...",
    "gender": "F",
    "status": "NIN_SUCCESS",
    "date_of_birth": "1992-05-15",
    "status_description": "NIN validated successfully."
  },
  "created_at": "2024-05-16T10:00:00Z",
  "completed_at": "2024-05-16T10:00:02Z"
}

Authorizations

ds-api-token · string · header · required

Path Parameters

applicant_id · string<uuid> · required

Existing applicant id

Example:

"01827ed5-c228-7a3c-9a31-7ab7cc169d13"

Body

application/json

Details for the non-document verification request.

Request body for initiating a non-document verification.

verification_type · enum<string> · required

Specifies the exact non-document verification check to perform.

Available options: NONDOC_BRAZIL_CPF_BASIC, NONDOC_BRAZIL_CPF_ONDEMAND, NONDOC_NIGERIA_NIN, NONDOC_NIGERIA_BVN_BASIC, NONDOC_NIGERIA_BVN_ADVANCED

Example:

"NONDOC_NIGERIA_NIN"

request_data · object · required

Contains the specific identifier needed for the check. The key depends on the verification_type.

Option 1

Option 2

Option 3

Show child attributes

Example:

{ "cpf": "11122233344" }

is_sandbox · boolean | null

If provided, overrides the organization's default sandbox setting for this specific call. Defaults to the organization's setting if omitted.

Response

200

application/json

Non-Document Verification Successful or Logically Failed

Response body for a non-document verification attempt.

request_id · string<uuid> · required

The unique ID for this verification attempt log.

Example:

"018f7b1a-1234-5678-9abc-def012345678"

status · enum<string> · required

The final status of the non-document verification check.

Available options: verified, failed

Example:

"verified"

verification_type · enum<string> · required

Specifies the exact non-document verification check to perform.

Available options: NONDOC_BRAZIL_CPF_BASIC, NONDOC_BRAZIL_CPF_ONDEMAND, NONDOC_NIGERIA_NIN, NONDOC_NIGERIA_BVN_BASIC, NONDOC_NIGERIA_BVN_ADVANCED

Example:

"NONDOC_NIGERIA_NIN"

country_code · string<ISO 3166-1 alpha-2> · required

The applicant's country code (ISO 3166-1 alpha-2) used for the check.

Example:

"NG"

response_data · object · required

Contains the JSON response from the underlying verification service. The structure varies based on the verification_type. Key fields typically include:

• status (string/enum): Status code/enum from the downstream service (e.g., NIN_SUCCESS, BVN_NAME_MISMATCH, CPF_SUCCESS).
• status_description (string): Description of the status. Other fields depend on the verification type:
• CPF (Brazil): Includes raw_data (a string containing JSON with CPF details like TaxIdNumber, Name, BirthDate, TaxIdStatus).
• NIN (Nigeria): Includes name (object), photo (base64 string), gender, date_of_birth.
• BVN Basic/Advanced (Nigeria): Includes an entity object containing BVN details. entity includes name (object), gender, date_of_birth, photo. The Advanced type returns more fields within entity like email, nationality, residential_address, enrollment_bank, etc.

Example:

{
  "status": "NIN_SUCCESS",
  "status_description": "Verification successful",
  "name": {
    "name": "Jane Doe",
    "first_name": "Jane",
    "last_name": "Doe"
  },
  "date_of_birth": "1992-05-15"
}

created_at · string<date-time> · required

ISO 8601 timestamp when the verification was initiated.

Example:

"2024-05-15T10:00:00Z"

completed_at · string<date-time> | null

ISO 8601 timestamp when the verification finished processing.

Example:

"2024-05-15T10:00:05Z"