Look up a NIN
POST /v1/identities/nin_lookups with the NIN and consent: true, your confirmation that the person
agreed to the lookup.
Response (201, photo shortened)
GET /v1/identities/nin_lookups/{id} returns it again, free. Only your organization, in the same mode,
can read it. We keep the record encrypted.
Pricing
A lookup costs ₦100 from the wallet of the key’s mode (test lookups spend test money); the current price is on the Billing page. It shows as anin_lookup_charge in
your transactions.
Send an
Idempotency-Key: a retry with the same key gets the first answer and isn’t charged again.
Live lookups allow 60 a minute per organization.
Use it in a registration
Set the proprietor’snin_lookup to the lookup’s id:
- Blank fields are filled from NIMC:
first_name,last_name,other_names,gender,date_of_birth,ninandphone. Fields you send are kept. Aninthat isn’t the lookup’s is400 parameter_invalid. - Submit checks the match. If
first_name,last_name,genderordate_of_birthdiffers from NIMC’s record (case and spacing don’t count), submit answers400 nin_mismatchnaming the field, before anything is charged. Once CAC queries a registration, its answer wins: a resubmit isn’t checked against the lookup.
Use the NIN photo as the passport
Instead of uploading a passport photo, send the lookup’sid as nin_lookup (and no file) with
kind=passport. NIMC’s photo becomes the passport; CAC accepts it.
photo first and let them choose between it and an upload. Only passport
takes a nin_lookup, and it must be for the proprietor’s own NIN: set their nin (or their own
nin_lookup) first, or it’s 400 parameter_invalid.
Test mode
Test lookups never reach NIMC. Every NIN returns the same test person (ADA CHIOMA OBI, female, 1990-04-12, a plain grey photo).?simulate=nin_not_found gives the 422 and
?simulate=insufficient_balance the 402.