PApaymongo
Verification

Create Identity Verification (API only flow)

Submit document images and a selfie photo directly to perform identity verification only with API (without the need to open hosted verification website). The caller uploads files via multipart/form-data.

Only the account itself or its parent account can create a verification session.

Primary vs Secondary IDs: Document types are classified as either primary or secondary. Primary IDs require only 1 document. Secondary IDs require 2 different secondary documents.

post/v2/accounts/{account_id}/identity_verification_api

Request

  • Base URL
    https://api.paymongo.com
  • URL
    https://api.paymongo.com/v2/accounts/{account_id}/identity_verification_api
  • Auth
    HTTP basic

Path parameters

account_idstring required

Unique identifier for the account

Request body multipart/form-data

document_type'alien_registration_card_ph' | 'barangay_clearance_ph' | 'driving_license_ph' | 'firearm_license_ph' | 'national_id_ph' | 'nbi_clearance_ph' | 'other_passport' | 'pag_ibig_ph' | 'passport' | 'philhealth_ph' | 'police_clearance_ph' | 'postal_id_ph' | 'prc_id_ph' | 'sssid_ph' | 'tin_id' | 'umid_ph' | 'voter_id_ph' required

Type of government-issued ID document. When a secondary ID is selected, a second different secondary document must be provided via secondary_document_type.

document_frontstring binary required

Front image of the ID document

selfiestring binary required

Selfie photo for liveness check and face match

document_backstring binary

Back image of the ID document. Required for the following document types: alien_registration_card_ph, driving_license_ph, national_id_ph, other_passport (signature page). Optional for all other document types.

secondary_document_type'alien_registration_card_ph' | 'barangay_clearance_ph' | 'nbi_clearance_ph' | 'pag_ibig_ph' | 'philhealth_ph' | 'police_clearance_ph' | 'postal_id_ph' | 'tin_id' | 'voter_id_ph'

Type of the second secondary ID document. Required when document_type is a secondary ID. Must be a secondary document type and must differ from document_type.

secondary_document_frontstring binary

Front image of the second secondary ID document. Required when secondary_document_type is present.

secondary_document_backstring binary

Back image of the second secondary ID document. Required when secondary_document_type is alien_registration_card_ph.

Example request

{
  "document_type": "national_id_ph",
  "secondary_document_type": "voter_id_ph"
}

Response

Verification session created successfully

Example response

{
  "data": {
    "id": "verif_8fb9ebfb16c6eb77c6a49b18",
    "account_id": "org_MF14z69iqitk9hrHKVpCJXdp",
    "status": "pending",
    "result": "pending",
    "created_at": 1680000000,
    "expired_at": 1680259200
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.