Performing test verifications

Overview

The "demo" field allows you to simulate different verification outcomes for testing purposes. This is useful for verifying API integration and handling various verification results without processing real user data.

Parameter Details

demo (required)

• Type: Object

• Description: Object containing demo-specific parameters.

demo.status (optional)

• Type: Boolean

• Description: Simulates the overall verification result.

• Values: true (Simulates a successful verification), false (Simulates a failed verification)

• Default: false.

demo. flag (optional)

• Type: Boolean

• Description: Simulates whether any of the component verifications were flagged for special consideration.

• Values: true (simulates a flagged verification), false (Simulates a non-flagged verification)

• Default: false.

Explanation of Terms

• Truthy: In this context, "truthy" refers to a successful verification result, indicated by a true value for the demo.status field.

• Flagged: "Flagged" indicates that one or more component verifications (e.g., document verification, email) produced results that require special attention or review.

Example Usage

Simulate a Successful Verification

To simulate a successful verification, set demo.status to true.

Example Request:

curl -X POST "https://api.bive.ai/identity/workflow/person" \
  -H "Content-Type: application/json" \
  -H "Api-Key: YOUR_BIVE_API_KEY" \
  -d '{
    "first_name": "John",
    "last_name": "Doe",
    "middle_name": "",
    "gov_id":  "gov-id-f5c0800f-c02b-4b9f-b5b5-64f8b99d1fb2.png",
    "email": "[email protected]",
    "phone_number": "[phone]",
    "date_of_birth": "1985-07-15",
    "address": {
      "country_code": "US",
      "state_code": "CA",
      "city": "San Francisco",
      "street_address1": "123 Main Street",
      "street_address2": "Apt 4B",
      "zip_code": "94107"
    },
    "job_title": "Software Engineer",
    "webhook_url": "https://your-webhook-endpoint.com",
    "liveness_check": true,
    "demo": { "status": true }
  }'

The API will return a response simulating a successful verification.

Simulate a Successful but Flagged Verification

To simulate a successful verification with flagged components, set both demo.status and demo.flag to true.

Example Request:

curl -X POST "https://api.bive.ai/identity/workflow/person" \
  -H "Content-Type: application/json" \
  -H "Api-Key: YOUR_BIVE_API_KEY" \
  -d '{
    "first_name": "John",
    "last_name": "Doe",
    "middle_name": "Michael",
    "gov_id":  "gov-id-f5c0800f-c02b-4b9f-b5b5-64f8b99d1fb2.png",
    "email": "[email protected]",
    "phone_number": "[phone]",
    "date_of_birth": "1985-07-15",
    "address": {
      "country_code": "US",
      "state_code": "CA",
      "city": "San Francisco",
      "street_address1": "123 Main Street",
      "street_address2": "Apt 4B",
      "zip_code": "94107"
    },
    "job_title": "Software Engineer",
    "webhook_url": "https://your-webhook-endpoint.com",
    "liveness_check": true,
    "demo": { "status": true, "flag": true }
  }'

The API will return a response simulating a successful verification with flagged components.

Example response body would appear here.

Simulate a Failed Verification

To simulate a failed verification, set demo.status to false (or omit the demo.status field, as false is the default).

Example Request:

curl -X POST "https://api.bive.ai/identity/workflow/person" \
  -H "Content-Type: application/json" \
  -H "Api-Key: YOUR_BIVE_API_KEY" \
  -d '{
    "first_name": "John",
    "last_name": "Doe",
    "middle_name": "Michael",
    "gov_id":  "gov-id-f5c0800f-c02b-4b9f-b5b5-64f8b99d1fb2.png",
    "email": "[email protected]",
    "phone_number": "[phone]",
    "date_of_birth": "1985-07-15",
    "address": {
      "country_code": "US",
      "state_code": "CA",
      "city": "San Francisco",
      "street_address1": "123 Main Street",
      "street_address2": "Apt 4B",
      "zip_code": "94107"
    },
    "job_title": "Software Engineer",
    "webhook_url": "https://your-webhook-endpoint.com",
    "liveness_check": true,
    "demo": { "status": false }
  }'

The API will return a response simulating a Failed verification.

Example response body would appear here.

Use Cases

• Integration Testing: Verify that your application correctly handles different verification outcomes.

• UI Testing: Test how your user interface displays Completed, Failed, and flagged verification results.

• Error Handling: Test your application's error handling for various API responses.

Best Practices

• Use the demo mode during development and testing, but disable it in production.

• Test all possible combinations of demo.status and demo.flag to ensure comprehensive testing.

• Document the demo mode behavior in your API documentation.

Note: You are not charged for demo verifications.