API Documentation
National Identity Number (NIN) Modification
Submit requests to modify specific details linked to a National Identity Number, such as changing a name, date of birth, or address. Modification requests undergo an approval process.
Endpoint
POST
/nin-modification
Headers
| Header | Value | Required |
|---|---|---|
Authorization |
Bearer YOUR_API_TOKEN |
Required |
Content-Type |
multipart/form-data |
Required |
Accept |
application/json |
Required |
This request requires
multipart/form-data formatting rather than standard JSON because file uploads (documents supporting the modification) are mandatory.
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
nin |
string |
The 11-digit NIN being modified. | Required |
tracking_id |
string |
The tracking ID associated with the original verifiable record. | Required |
modification_type |
string |
The type of modification (e.g., name, dob, address). |
Required |
new_value |
string |
The new value representing the modification. | Required |
supporting_document |
file |
A PDF or image (JPEG/PNG) document proving the validity of the modification (e.g., marriage certificate for name change, court affidavit). | Required |
Example Response
JSON
{
"status": true,
"message": "NIN Modification Request Submitted Successfully",
"data": {
"reference": "MOD-100200300",
"nin": "12345678901",
"modification_type": "name",
"status": "pending_approval",
"submitted_at": "2024-03-05T16:00:22Z"
}
}