NIN IPE Clearance API

Submit and track National Identification Number (NIN) IPE (Identity Pattern Extraction) clearance requests using an Enrolment Tracking ID.

Service Online / Available

POST /api/v1/nin/ipe

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
`002`	IPE	instant ipe on failed enrollment	₦800.00	Available
`500`	Modification IPE	IPE clearance service	₦1,000.00	Available

Request Parameters (POST)

PARAMETER	TYPE	DESCRIPTION	REQUIRED
`field_code`	string	Authorized IPE service field code (e.g. `002` for IPE, `500` for Modification IPE).	Required
`tracking_id`	string	The Enrolment Tracking ID to be cleared (minimum 8 alphanumeric characters).	Required
`description`	string	Optional notes or reference information regarding the clearance request.	Optional

Request & Response Examples

JSON Payload

{
  "field_code": "002",
  "tracking_id": "ABC123XYZ890",
  "description": "IPE clearance for enrolment tracking ID"
}

Success Response (200 OK)

{
  "status": "success",
  "code": 200,
  "message": "Request submitted, pending processing",
  "data": {
    "reference": "IPE-1729602490-ABCD",
    "trx_ref": "TXN_7296024901",
    "status": "pending",
    "response": "Request submitted, pending processing"
  }
}

Check Status (GET)

GET /api/v1/nin/ipe?tracking_id={tracking_id}

Query Parameters

PARAMETER	TYPE	DESCRIPTION	REQUIRED
`tracking_id`	string	The tracking ID previously submitted. Alternatively pass the Request ID in the URL path: `/api/v1/nin/ipe/{id}`.	Required

Check Status Response (200 OK)

{
  "status": "success",
  "code": 200,
  "tracking_id": "ABC123XYZ890",
  "status": "completed",
  "comment": "IPE clearance approved and resolved successfully.",
  "message": "Status checked."
}