BVN Central Risk Management (CRM) API

Submit and track Central Risk Management (CRM) verification and clearance requests linked to a Bank Verification Number.

Service Online / Available

POST /api/v1/bvn/crm

Authentication & Headers

HEADER	VALUE	REQUIRED
`Authorization`	`Bearer YOUR_API_TOKEN`	Yes
`Content-Type`	`application/json`	Yes
`Accept`	`application/json`	Yes

Authorized Field Codes & Realtime Pricing

Role: Default

FIELD CODE	SERVICE NAME	DESCRIPTION	PRICE (₦)	STATUS
`021`	Central Risk Management	Get bvn on the entolment response...	₦1,500.00	Available
`063`	BVN CRM	Get bvn enrollment response on the...	₦800.00	Available

Request Parameters (POST)

PARAMETER	TYPE	DESCRIPTION	REQUIRED
`field_code`	string	Authorized active CRM field code (e.g. `021`).	Required
`ticket_id`	string	Valid 8-digit CRM Ticket ID (e.g. `12345678`).	Required
`batch_id`	string	Valid 7-digit CRM Batch ID (e.g. `1234567`).	Required

Example Submit Request

cURL (POST)

curl -X POST "https://www.api.arewasmart.com.ng/api/v1/bvn/crm" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{
    "field_code": "021",
    "ticket_id": "12345678",
    "batch_id": "1234567"
  }'

Success Response (200 OK)

200 OK

{
  "status": "success",
  "code": 200,
  "message": "Request submitted, pending processing",
  "data": {
    "reference": "CRM4559R2DYP",
    "status": "pending",
    "ticket_id": "12345678",
    "batch_id": "1234567",
    "service": "Central Risk Management",
    "comment": "Your request is processing, it will be treated in 24 to 72h"
  }
}

Failed Response (400 Bad Request)

400 Bad Request

{
  "status": "failed",
  "code": 400,
  "message": "The selected field code is not authorized for CRM requests."
}

Check CRM Status

GET /api/v1/bvn/crm?ticket_id=12345678

Query Parameters (GET)

PARAMETER	TYPE	DESCRIPTION	REQUIRED
`ticket_id`	string	The 8-digit CRM Ticket ID submitted with the request.	Optional*
`batch_id`	string	The 7-digit CRM Batch ID submitted with the request.	Optional*
`reference`	string	The transaction reference returned upon submission (e.g. `CRM4559R2DYP`).	Optional*

* Note: You must provide at least one query parameter (ticket_id, batch_id, or reference) to retrieve the status.

Example Status Check Request

cURL (GET)

# Query by Ticket ID:
curl -X GET "https://www.api.arewasmart.com.ng/api/v1/bvn/crm?ticket_id=12345678" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Accept: application/json"

# Alternatively query by Reference:
curl -X GET "https://www.api.arewasmart.com.ng/api/v1/bvn/crm?reference=CRM4559R2DYP" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Accept: application/json"

Status Check Response (200 OK)

200 OK

// When completed:
{
  "status": "success",
  "code": 200,
  "message": "Status checked.",
  "data": {
    "reference": "CRM4559R2DYP",
    "ticket_id": "12345678",
    "batch_id": "1234567",
    "service": "Central Risk Management",
    "status": "completed",
    "comment": "CRM verification completed and records updated successfully.",
    "file_url": null,
    "submission_date": "2026-10-22 10:30:00"
  }
}

// When pending:
{
  "status": "success",
  "code": 200,
  "message": "Status checked.",
  "data": {
    "reference": "CRM4559R2DYP",
    "ticket_id": "12345678",
    "batch_id": "1234567",
    "service": "Central Risk Management",
    "status": "pending",
    "comment": "Your request is processing, it will be treated in 24 to 72h",
    "file_url": null,
    "submission_date": "2026-10-22 10:30:00"
  }
}