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

# Kartu Keluarga (KK) Details Extraction

> Perform OCR on an Indonesian Kartu Keluarga (family card) and return the extracted fields.



## OpenAPI

````yaml api-reference/openapi.json POST /api/v3/verifications/indonesia/kartu-keluarga-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/kartu-keluarga-details-extraction:
    post:
      tags:
        - OCR
      summary: Kartu Keluarga (KK) Details Extraction
      description: >-
        Perform OCR on an Indonesian Kartu Keluarga (family card) document and
        return the extracted fields, including the family card number, head of
        family, address, and family members.
      operationId: indonesiaKartuKeluargaDetailsExtractionV3
      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 Kartu Keluarga document.
                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 Kartu Keluarga extraction processed successfully
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/IdnKartuKeluargaDetailsExtractionV3Response
              example:
                success: true
                message: Indonesia Kartu Keluarga extraction processed successfully
                data:
                  outcome: extracted
                  fields:
                    no_kk: '3201234567890001'
                    head_of_family: SITI RAHAYU
                    address:
                      street: JL. MELATI RAYA NO. 10
                      rt: '001'
                      rw: '002'
                      village: SUKAMAJU
                      district: CILODONG
                      city: KOTA BOGOR
                      province: JAWA BARAT
                      postal_code: '16913'
                    members:
                      - name: SITI RAHAYU
                        nik: '3201016104960001'
                        blood_type: '0'
                        gender: PEREMPUAN
                        place_of_birth: BOGOR
                        date_of_birth: '1996-04-14'
                        religion: ISLAM
                        education: DIPLOMA IV/STRATA I
                        occupation: KARYAWAN SWASTA
                        marital_status: BELUM KAWIN
                        relationship: KEPALA KELUARGA
                        citizenship: WNI
                        father_name: AHMAD SUPRIYADI
                        mother_name: DEWI LESTARI
                      - name: RINA KUSUMA
                        nik: '3201015402970002'
                        blood_type: '0'
                        gender: PEREMPUAN
                        place_of_birth: BOGOR
                        date_of_birth: '1997-02-04'
                        religion: ISLAM
                        education: DIPLOMA IV/STRATA I
                        occupation: KARYAWAN SWASTA
                        marital_status: BELUM KAWIN
                        relationship: FAMILI LAIN
                        citizenship: WNI
                        father_name: AHMAD SUPRIYADI
                        mother_name: DEWI LESTARI
                    issued_date: '2023-03-31'
                    issuing_city: KOTA BOGOR
                  missingFields: []
                verificationStatus: VERIFIED
                verificationStatusCode: 3
                trustFlowId: 0
                trustValidationId: '{your_trust_validation_id}'
                verificationType: kartu_keluarga_details_extraction
                metadata: null
                createdAt: 2026-07-14 00:27:50+0000
components:
  schemas:
    IdnKartuKeluargaDetailsExtractionV3Response:
      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:
                no_kk:
                  type: string
                  description: 16-digit family card number.
                head_of_family:
                  type: string
                  description: Name of the head of the family.
                address:
                  type: object
                  properties:
                    street:
                      type: string
                    rt:
                      type: string
                    rw:
                      type: string
                    village:
                      type: string
                    district:
                      type: string
                    city:
                      type: string
                    province:
                      type: string
                    postal_code:
                      type: string
                members:
                  type: array
                  description: Family members listed on the card.
                  items:
                    type: object
                    properties:
                      name:
                        type: string
                      nik:
                        type: string
                        description: Indonesian National Identity Number (16-digit NIK).
                      blood_type:
                        type: string
                      gender:
                        type: string
                      place_of_birth:
                        type: string
                      date_of_birth:
                        type: string
                      religion:
                        type: string
                      education:
                        type: string
                      occupation:
                        type: string
                      marital_status:
                        type: string
                      relationship:
                        type: string
                        description: Relationship to the head of the family.
                      citizenship:
                        type: string
                      father_name:
                        type: string
                      mother_name:
                        type: string
                issued_date:
                  type: string
                issuing_city:
                  type: string
            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.

````