Create Verification

POST Create Verification

http://localhost:8009/api/v1/modular/verificationlocalhostlocalhost

Body raw (json)

{
  "customer_id": "697226bcc043b64f205740c8",
  "country": "NG",
  "callback": "https://webhook.site/7cbde82f-3bcb-4747-979e-42883261a2a4",
  "redirect": "https://webhook.site/7cbde82f-3bcb-4747-979e-42883261a2a4",
  "branding": {
    "bg_color": "#1a1a2e",
    "text_color": "#ffffff",
    "button_color": "#00ff88",
    "brand_logo": "https://example.com/logo.png",
    "brand_name": "Xyz"
  },
  "individual_checks": {
    "verification_types": {
      "bvn": true,
      "nin": true,
      "phone": true,
      "email": true
    },
    "address_verification": {
      "enabled": true,
      "upload_proof_of_address": true
    },
    "bio": true,
    "document_verification": true,
    "disclaimer": true
  },
  "business_checks": {
    "tin": true,
    "cac": true
  },
  "aml_checks": {
    "aml_check": true,
    "sanction_list": true
  },
  "additional_fields": [
    {
      "field_name": "mother_maiden_name",
      "data_type": "text",
      "field_description": "Enter your mother's maiden name",
      "is_required": true
    }
  ]
}

Example Request

curl --location 'http://localhost:8009/api/v1/modular/verification' \
--data '{
  "customer_id": "697226bcc043b64f205740c8",
  "country": "NG",
  "callback": "https://webhook.site/7cbde82f-3bcb-4747-979e-42883261a2a4",
  "redirect": "https://webhook.site/7cbde82f-3bcb-4747-979e-42883261a2a4",
  "branding": {
    "bg_color": "#1a1a2e",
    "text_color": "#ffffff",
    "button_color": "#00ff88",
    "brand_logo": "https://example.com/logo.png",
    "brand_name": "Xyz"
  },
  "individual_checks": {
    "verification_types": {
      "bvn": true,
      "nin": true,
      "phone": true,
      "email": true
    },
    "address_verification": {
      "enabled": true,
      "upload_proof_of_address": true
    },
    "bio": true,
    "document_verification": true,
    "disclaimer": true
  },
  "business_checks": {
    "tin": true,
    "cac": true
  },
  "aml_checks": {
    "aml_check": true,
    "sanction_list": true
  },
  "additional_fields": [
    {
      "field_name": "mother_maiden_name",
      "data_type": "text",
      "field_description": "Enter your mother'\''s maiden name",
      "is_required": true
    }
  ]
}'

Example Response

{
  "verification_id": "69689365006455277cf86d29",
  "reference": "VRF_32c25c90-3d83-4b43-9e40-5d3ad483ec37",
  "verification_url": "https://your-frontend-url.com/modular/verify/69689365006455277cf86d29",
  "todo": [
    "bvn",
    "nin",
    "phone",
    "liveliness",
    "address_verification",
    "bio",
    "disclaimer",
    "tin",
    "cac",
    "aml_check",
    "sanction_list"
  ],
  "total_checks": 11,
  "status": "pending"
}