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

# KTP Details Extraction

> Perform OCR on an Indonesian KTP (national identity) card and return the extracted fields.



## OpenAPI

````yaml api-reference/openapi.json POST /api/v3/verifications/indonesia/ktp-details-extraction
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/indonesia/ktp-details-extraction:
    post:
      tags:
        - OCR
      summary: KTP Details Extraction
      description: >-
        Perform OCR on an Indonesian KTP (national identity) card and return the
        extracted fields, including the NIK, name, address, and cropped
        signature and photo images.
      operationId: indonesiaKtpDetailsExtractionV3
      parameters:
        - name: Accept
          in: header
          required: false
          schema:
            type: string
            default: application/json
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              type: object
              required:
                - documentImage
                - trustFlowId
                - trustValidationId
              properties:
                documentImage:
                  type: string
                  format: binary
                  description: Image file of the KTP card.
                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.
      responses:
        '200':
          description: Indonesia KTP details extraction processed successfully
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IdnKtpDetailsExtractionV3Response'
              example:
                success: true
                message: Indonesia KTP details extraction processed successfully
                data:
                  outcome: extracted
                  fields:
                    nik: '3201011606810001'
                    name: BUDI SANTOSO
                    place_of_birth: JAKARTA
                    date_of_birth: '1981-06-16'
                    gender: LAKI-LAKI
                    blood_type: AB
                    address:
                      street: JL. MELATI RAYA NO. 10
                      rt: '001'
                      rw: '002'
                      village: SUKAMAJU
                      district: CILODONG
                    religion: ISLAM
                    marital_status: KAWIN
                    occupation: KARYAWAN SWASTA
                    citizenship: WNI
                    valid_until: SEUMUR HIDUP
                    province: JAWA BARAT
                    city: KOTA BOGOR
                    issued_date: '2023-01-30'
                    signature: >-
                      https://media-cdn.portalph.idmetagroup.com/{tenant_id}/{trust_validation_id}/signature-{image_id}.jpeg
                    photo: >-
                      https://media-cdn.portalph.idmetagroup.com/{tenant_id}/{trust_validation_id}/photo-{image_id}.jpeg
                  missingFields: []
                verificationStatus: VERIFIED
                verificationStatusCode: 3
                trustFlowId: 0
                trustValidationId: '{your_trust_validation_id}'
                verificationType: ktp_details_extraction
                metadata: null
                createdAt: 2026-07-16 09:55:20+0000
components:
  schemas:
    IdnKtpDetailsExtractionV3Response:
      type: object
      properties:
        success:
          type: boolean
        message:
          type: string
        data:
          type: object
          properties:
            outcome:
              type: string
              description: Extraction outcome, for example `extracted`.
            fields:
              type: object
              properties:
                nik:
                  type: string
                  description: Indonesian National Identity Number (16-digit NIK).
                name:
                  type: string
                place_of_birth:
                  type: string
                date_of_birth:
                  type: string
                  description: Date of birth in `YYYY-MM-DD` format.
                gender:
                  type: string
                blood_type:
                  type: string
                address:
                  type: object
                  properties:
                    street:
                      type: string
                    rt:
                      type: string
                    rw:
                      type: string
                    village:
                      type: string
                    district:
                      type: string
                religion:
                  type: string
                marital_status:
                  type: string
                occupation:
                  type: string
                citizenship:
                  type: string
                valid_until:
                  type: string
                  description: Card validity, for example `SEUMUR HIDUP` (lifetime).
                province:
                  type: string
                city:
                  type: string
                issued_date:
                  type: string
                signature:
                  type: string
                  format: uri
                  description: URL of the cropped signature image.
                photo:
                  type: string
                  format: uri
                  description: URL of the cropped photo image.
            missingFields:
              type: array
              description: Fields that could not be extracted from the document.
              items:
                type: string
        verificationStatus:
          type: string
        verificationStatusCode:
          type: integer
        trustFlowId:
          type: integer
        trustValidationId:
          type: string
        verificationType:
          type: string
        metadata:
          nullable: true
        createdAt:
          type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Use `Bearer {your_api_token}` in the Authorization header.

````