> ## 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.

# BVN Search

> ```
POST api/v1/kyc/bvn
```




## OpenAPI

````yaml kyc-model.json POST /kyc/bvn
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/bvn:
    post:
      summary: BVN Search
      description: >-
        Searches by BVN. Sends a POST request to the KYC BVN endpoint to
        retrieve verification details for an individual using their Bank
        Verification Number.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BvnSearchRequest'
            example:
              idNumber: '22241887099'
      responses:
        '200':
          description: BVN lookup successful
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericResponse'
              example:
                message: BVN lookup successful
                data:
                  idNumber: '22241887099'
                  firstName: ERNEST
                  lastName: TARZUA
                  middleName: NAJIME
                  dateOfBirth: '1989-04-15'
                  gender: male
                  phoneNumber: '08037997380'
                  phoneNumber2: null
                  nationality: Nigeria
                  address: UNIVERSITY OF ABUJA MALE HOSTEL GWAGWALADA FCT ABUJA
                  photo: data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAAAQABAAD...
                  email: null
                  registrationDate: null
                  enrollmentBank: null
                  enrollmentBranch: null
                  levelOfAccount: null
                  lgaOfOrigin: Gboko
                  lgaOfResidence: Gwagwalada
                  stateOfOrigin: Benue State
                  stateOfResidence: null
                  maritalStatus: Single
                  nameOnCard: null
                  title: null
                  watchListed: 'False'
                  linkedNin: 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:
    BvnSearchRequest:
      type: object
      required:
        - idNumber
      properties:
        idNumber:
          type: string
          description: The Bank Verification Number (BVN) to look up
          example: '22241887099'
      example:
        idNumber: '22241887099'
    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

````