> ## Documentation Index
> Fetch the complete documentation index at: https://sigma-docs.pastelhq.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# NIN Search

> ```
POST api/v1/kyc/nin
```




## OpenAPI

````yaml kyc-model.json POST /kyc/nin
openapi: 3.1.0
info:
  title: Sigma KYC API
  description: Know Your Customer API documentation
  version: 1.0.0
  license:
    name: MIT
servers:
  - url: https://sigmacdd.sabipay.com/api/v1
    description: Production
security:
  - ApiKey: []
    ApiSecret: []
paths:
  /kyc/nin:
    post:
      summary: NIN Search
      description: >-
        Searches by NIN. Sends a POST request to the KYC NIN endpoint to
        retrieve verification details for an individual using their National
        Identification Number.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NinSearchRequest'
            example:
              idNumber: '98864126516'
      responses:
        '200':
          description: NIN lookup successful
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericResponse'
              example:
                message: NIN lookup successful
                data:
                  idNumber: '98864126516'
                  firstName: EDDY
                  lastName: UDOM
                  middleName: GODWIN
                  dateOfBirth: '2023-08-19'
                  gender: male
                  phoneNumber: '08124698785'
                  address: PLOT 20 BLOCK I AKWA IMA ESTATE, IKOT AKPAN ABIA. UYO
                  photo: data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAAAQABAAD...
                  nationality: Nigeria
                  title: null
                  maritalStatus: null
                  height: null
                  employmentStatus: null
                  educationLevel: null
                  profession: null
                  religion: null
                  spokenLanguage: null
                  virtualNin: null
                  preferredFirstName: null
                  preferredMiddleName: null
                  preferredSurname: null
                  birthCountry: Not Available
                  birthState: null
                  birthLga: null
                  residenceState: null
                  residenceLga: null
                  residenceTown: null
                  residenceStatus: null
                  originState: null
                  originLga: null
                  originPlace: null
                  nokFirstName: BLESSING
                  nokMiddleName: ONYIYECHI
                  nokSurname: null
                  nokAddress: PLOT 20 BLOCK I AKWA IMA ESTATE, IKOT AKPAN ABIA. UYO
                  nokLga: Uyo
                  nokState: null
                  nokTown: UYO
                  nokPostcode: null
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    NinSearchRequest:
      type: object
      required:
        - idNumber
      properties:
        idNumber:
          type: string
          description: The National Identification Number (NIN) to look up
          example: '98864126516'
      example:
        idNumber: '98864126516'
    GenericResponse:
      type: object
      properties:
        message:
          type: string
          description: Response message
        data:
          type: object
          description: Response data
    ErrorResponse:
      type: object
      properties:
        message:
          type: string
          description: Error message
      example:
        message: 'Invalid request: idNumber is required'
  securitySchemes:
    ApiKey:
      type: apiKey
      in: header
      name: apiKey
    ApiSecret:
      type: apiKey
      in: header
      name: apiSecret

````