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

# NBI Clearance

> Verify Philippine NBI clearance status against official records.



## OpenAPI

````yaml api-reference/openapi.json POST /api/v3/verifications/philippines/nbi
openapi: 3.0.3
info:
  title: IDmeta API
  description: IDmeta verification and integration API.
  license:
    name: MIT
  version: 1.0.0
servers:
  - url: https://{environment-subdomain}.idmetagroup.com
    description: Your environment (replace `{environment-subdomain}`)
    variables:
      environment-subdomain:
        default: integrate
        description: IDmeta environment subdomain
security:
  - bearerAuth: []
tags:
  - name: Processes
    description: Verification process endpoints
  - name: Trust Flow Links
    description: Trust Flow link generation endpoints
  - name: Compliance
    description: Compliance verification endpoints
  - name: Government Data
    description: Government data verification endpoints
  - name: Alternative Verifications
    description: Alternative verification and intelligence endpoints
  - name: OCR
    description: Document OCR extraction endpoints
paths:
  /api/v3/verifications/philippines/nbi:
    post:
      tags:
        - Government Data
      summary: NBI Clearance
      description: Verify Philippines NBI clearance details (API v3).
      operationId: philippinesNbiClearanceVerificationV3
      parameters:
        - name: Accept
          in: header
          required: false
          schema:
            type: string
            default: application/json
        - name: Content-Type
          in: header
          required: false
          schema:
            type: string
            default: application/json
        - name: Authorization
          in: header
          required: true
          description: Bearer token (`Bearer {your_api_token}`).
          schema:
            type: string
            example: Bearer {your_api_token}
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PhNbiClearanceV3Request'
            examples:
              default:
                summary: NBI clearance verification request (v3)
                value:
                  clearanceNo: <string>
                  trustFlowId: 0
                  trustValidationId: '{your_trust_validation_id}'
      responses:
        '200':
          description: Philippines NBI Clearance processed successfully
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PhNbiClearanceV3Response'
              example:
                success: true
                message: Philippines NBI Clearance processed successfully
                data:
                  fullName: <string>
                  photo: >-
                    http://alpha-ws.nbi-clearance.io/api/v1/profile/temp/picture/M614EAEL28-FM249100?expires=1765251779&signature=096415321ee37db4721098452f79e437ef230994d8a3fa123123123
                  clearanceExpiry: September 4, 2018
                  occupation: <string>
                  isExpired: true
                  took: 2
                  hasPin: false
                  statusCode: 200
                  clearanceNumber: <string>
                  lastname: <string>
                  firstname: <string>
                  middlename: <string>
                  isValid: false
                verificationStatus: VERIFIED
                verificationStatusCode: 3
                trustFlowId: 0
                trustValidationId: '{your_trust_validation_id}'
                verificationType: philippines_nbi_clearance
                metadata:
                  dob: 21/12/1993
                  user_id: '12345'
                  fullname: <string>
components:
  schemas:
    PhNbiClearanceV3Request:
      type: object
      required:
        - clearanceNo
        - trustFlowId
        - trustValidationId
      properties:
        clearanceNo:
          type: string
          description: Philippines NBI Clearance number for verification.
        trustFlowId:
          type: integer
          description: >-
            Identifier used to categorize or group requests for tracking or
            reporting.
        trustValidationId:
          type: string
          description: A unique ID used to identify your verification request.
    PhNbiClearanceV3Response:
      type: object
      properties:
        success:
          type: boolean
        message:
          type: string
        data:
          type: object
          properties:
            fullName:
              type: string
            photo:
              type: string
            clearanceExpiry:
              type: string
            occupation:
              type: string
            isExpired:
              type: boolean
            took:
              type: integer
            hasPin:
              type: boolean
            statusCode:
              type: integer
            clearanceNumber:
              type: string
            lastname:
              type: string
            firstname:
              type: string
            middlename:
              type: string
            isValid:
              type: boolean
        verificationStatus:
          type: string
        verificationStatusCode:
          type: integer
        trustFlowId:
          type: integer
          description: Trust flow ID (numeric or echoed identifier).
        trustValidationId:
          type: string
          format: uuid
        verificationType:
          type: string
        metadata:
          type: object
          additionalProperties: true
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Use `Bearer {your_api_token}` in the Authorization header.

````