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

# UMID / SSN

> Verify a Philippines UMID or Social Security number.



## OpenAPI

````yaml stateless-verification-api/philippines-government/umid-ssn.openapi.json POST /api/v3/verifications/philippines/umid-ssn-passthrough
openapi: 3.0.3
info:
  title: Philippines Government Verification API - UMID / SSN
  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: []
paths:
  /api/v3/verifications/philippines/umid-ssn-passthrough:
    post:
      tags:
        - Philippines Government Verification
      summary: UMID / SSN
      description: Verify a Philippines UMID or Social Security number.
      parameters:
        - name: Authorization
          in: header
          required: true
          schema:
            type: string
            example: Bearer {your_api_token}
        - 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
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UMIDSSNRequest'
            examples:
              default:
                summary: UMID / SSN lookup
                value:
                  documentNumber: '123456789012'
                  metadata:
                    yourRef: case-1002
      responses:
        '200':
          description: >-
            Request processed. Check `data.isValid` and `verificationStatus` to
            determine the outcome.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PhilippinesPassthroughSuccessResponse'
              examples:
                valid:
                  summary: Verified result
                  value:
                    success: true
                    message: Philippines UMID/SSN processed successfully
                    data:
                      isValid: true
                    verificationStatus: VERIFIED
                    verificationStatusCode: 3
                    transactionId: 79b6f81c-fc48-42ce-b907-763129b0957e
                    verificationType: philippines_umid_ssn
                    metadata:
                      yourRef: case-1001
                    createdAt: 2026-09-01 08:00:00+0000
                rejected:
                  summary: Rejected result (still HTTP 200)
                  value:
                    success: true
                    message: Philippines UMID/SSN processed successfully
                    data:
                      isValid: false
                    verificationStatus: REJECTED
                    verificationStatusCode: 1
                    transactionId: 79b6f81c-fc48-42ce-b907-763129b0957e
                    verificationType: philippines_umid_ssn
                    metadata:
                      yourRef: case-1001
                    createdAt: 2026-09-01 08:00:00+0000
        '400':
          description: >-
            Validation failed. Unsupported QR formats and invalid or expired
            liveness sessions also use this response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PhilippinesValidationErrorResponse'
              examples:
                invalidRequest:
                  summary: Validation failed
                  value:
                    success: false
                    code: VALIDATION_FAILED
                    message: >-
                      The request could not be validated. Please check the
                      submitted fields.
                    errors:
                      documentNumber:
                        - The document number field is required.
                    transactionId: null
                    verificationType: philippines_umid_ssn
                    createdAt: 2026-09-01 08:00:00+0000
        '500':
          description: Internal error or Philippine government source unavailable.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PhilippinesPassthroughErrorResponse'
              examples:
                internalError:
                  summary: Internal error
                  value:
                    success: false
                    code: INTERNAL_ERROR
                    message: >-
                      An internal error has occurred while processing your
                      request. Please try again later.
                    verificationStatus: FAILED
                    verificationStatusCode: 6
                    transactionId: f43156f1-c11c-4a38-92d9-c2d3221eba5b
                    verificationType: philippines_umid_ssn
                    metadata:
                      yourRef: case-1001
                    createdAt: 2026-09-01 08:00:00+0000
                sourceUnavailable:
                  summary: Philippine government source unavailable
                  value:
                    success: false
                    code: PH_GOV_UNAVAILABLE
                    message: >-
                      The Philippine government source is currently unavailable.
                      Please try again later.
                    verificationStatus: FAILED
                    verificationStatusCode: 6
                    transactionId: f43156f1-c11c-4a38-92d9-c2d3221eba5b
                    verificationType: philippines_umid_ssn
                    metadata:
                      yourRef: case-1001
                    createdAt: 2026-09-01 08:00:00+0000
components:
  schemas:
    UMIDSSNRequest:
      type: object
      required:
        - documentNumber
      properties:
        documentNumber:
          type: string
          description: UMID CRN or Social Security number.
          example: '123456789012'
          minLength: 10
          maxLength: 20
        metadata:
          type: object
          additionalProperties: true
          description: >-
            Optional key-value pairs echoed back in completed and source-error
            responses.
    PhilippinesPassthroughSuccessResponse:
      type: object
      required:
        - success
        - message
        - data
        - verificationStatus
        - verificationStatusCode
        - transactionId
        - verificationType
        - createdAt
      properties:
        success:
          type: boolean
          example: true
        message:
          type: string
        data:
          type: object
          required:
            - isValid
          additionalProperties: true
          description: >-
            CamelCase result fields for this verification type. Additional
            source fields may be returned when available.
          properties:
            isValid:
              type: boolean
              description: Whether the source verified the submitted document number.
        verificationStatus:
          type: string
          enum:
            - VERIFIED
            - REJECTED
        verificationStatusCode:
          type: integer
          enum:
            - 3
            - 1
          description: '`3` = Verified, `1` = Rejected.'
        transactionId:
          type: string
          format: uuid
        verificationType:
          type: string
          example: philippines_umid_ssn
        metadata:
          type: object
          additionalProperties: true
          nullable: true
        createdAt:
          type: string
          example: 2026-09-01 08:00:00+0000
    PhilippinesValidationErrorResponse:
      type: object
      required:
        - success
        - code
        - message
        - errors
        - transactionId
        - verificationType
        - createdAt
      properties:
        success:
          type: boolean
          example: false
        code:
          type: string
          enum:
            - VALIDATION_FAILED
        message:
          type: string
        errors:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
        transactionId:
          type: string
          format: uuid
          nullable: true
          description: >-
            Null for upfront validation; present when a liveness session fails
            after the transaction starts.
        verificationType:
          type: string
          example: philippines_umid_ssn
        metadata:
          type: object
          additionalProperties: true
          nullable: true
        createdAt:
          type: string
    PhilippinesPassthroughErrorResponse:
      type: object
      required:
        - success
        - code
        - message
        - verificationStatus
        - verificationStatusCode
        - transactionId
        - verificationType
        - createdAt
      properties:
        success:
          type: boolean
          example: false
        code:
          type: string
          enum:
            - PH_GOV_UNAVAILABLE
            - INTERNAL_ERROR
        message:
          type: string
        verificationStatus:
          type: string
          example: FAILED
        verificationStatusCode:
          type: integer
          example: 6
        transactionId:
          type: string
          format: uuid
        verificationType:
          type: string
          example: philippines_umid_ssn
        metadata:
          type: object
          additionalProperties: true
          nullable: true
        createdAt:
          type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Use your API token as a Bearer token in the `Authorization` header.

````