# NIN

The Nigeria NIN (National Identification Number) service provides a method for checking and confirming person idenitity using their NIN. It utilizes the provided 11-digit NIN to query the official national database. The service returns a detailed response including the NIN holder's registered identity data (full name, date of birth, address, and gender) upon a successful match.

Endpoint: POST /services/ng/nin
Version: 1.0
Security: API-Key

## Request fields (application/json):

  - `nin_number` (string)
    The Nigerian National Identification Number (NIN), a unique 11-digit identifier issued by the National Identity Management Commission (NIMC)
    Example: 38109457262

## Response 200 fields (application/json):

  - `validation` (object)

  - `validation.valid` (boolean)
    Example: true

  - `data` (object)

  - `data.nin` (string)
    The Nigerian National Identification Number (NIN), a unique 11-digit identifier issued by the National Identity Management Commission (NIMC)
    Example: 38109457262

  - `data.first_name` (string | null)
    The first name of a person
    Example: Josh

  - `data.middle_name` (string | null)
    The middle name of a person
    Example: David

  - `data.last_name` (string | null)
    The last name of a person
    Example: Coffey

  - `data.dob` (string | null)
    The date of birth of a person, formatted as “YYYY-MM-DD” according to ISO 8601
    Example: 1976-02-21

  - `data.phone` (string | null)
    The phone number of a person or a company
    Example: 441172345678

  - `data.email` (string | null)
    The email address of a person or a company
    Example: josh.coffey@example.com

  - `data.gender` (string | null)
    The gender of a person. `M` indicates male; `F` indicates female
    Enum: "M", "F"

  - `data.residence_country` (string | null)
    A residence country of an object. A two-letter country code according to ISO 3166-2
    Example: GB

  - `data.profile_image` (string)
    A profile image of a person in base64 binary format
    Example: /9j/4AAQSkZJRgABAQAAAQABAAD/4gHYSUNDX1BST0ZJTEUAAQEAAAHIAAAAAAQwA[...]

  - `data.address` (object)

  - `data.address.country` (string | null)
    A country of an object. A two-letter country code according to ISO 3166-2
    Example: GB

  - `data.address.state` (string | null)
    A state of a person or a company
    Example: null

  - `data.address.district` (string | null)
    The district (an area of a city) of an object
    Example: Westminster

  - `data.address.address` (string | null)
    An address (a street name, a building number, and a unit number) of a person or a company
    Example: 45 High Street, Flat 2A

## Response 400 fields (application/json):

  - `type` (string)
    Example: bad_request

  - `errors` (array)

## Response 402 fields (application/json):

  - `type` (string)
    Example: insufficient_funds

  - `errors` (array)

## Response 404 fields (application/json):

  - `validation` (object)

  - `validation.valid` (boolean)
    Example: false

  - `data` (object)

  - `data.nin` (string)
    The Nigerian National Identification Number (NIN), a unique 11-digit identifier issued by the National Identity Management Commission (NIMC)
    Example: 38109457262

## Response 422 fields (application/json):

  - `type` (string)
    Example: validation

  - `errors` (array)

  - `errors.parameter` (string)
    Example: nin_number

  - `errors.message` (string)
    Example: NIN number is required

## Response 500 fields (application/json):

  - `type` (string)
    Example: internal_server

  - `errors` (array)