📋 Table of Contents

• • Overview
• • How It Works
• • Sequence Diagram
• • Authentication
• • API Reference Guide

---

1. Overview

The eKYCPH Partner API enables secure identity verification through our platform. Our API allows partners to:

• ✅ Check API health status for system monitoring
• 🔄 Begin, authenticate, and confirm eKYC reuse processes
• 📊 Retrieve available eKYC providers and their capabilities
• 📚 API Reference Guide

---

2. How It Works: The eKYC Reuse Process

In order to reuse an eKYC record of a user, follow these steps:

1. Initiate the Process
   Call the begin-ekyc-reuse endpoint
   Required parameters:
   • Phone number (international format, e.g., +639123456789)
   • Provider name (found in Dashboard)
   Result: Returns a Session ID and sends OTP to user’s phone


2. Authenticate the User
   Call the authenticate-ekyc-reuse endpoint
   Required parameters:
   • Session ID (from step 1)
   • OTP (sent to phone)
   • User’s last name
   • Optional PIN
   • Optional “from-provider-name”
   Result: If successful, returns eKYC record and a new Session ID
   

   Note: Without a specified provider name, the system searches across all available identity providers.



3. Confirm eKYC Reuse
   Call the confirm-ekyc-reuse endpoint after user confirmation
   Required parameters:
   • Session ID (from step 2)
   • OTP (sent to phone)
   Result: Returns a Session ID for future API requests

---

3. Sequence Diagram

Client App --> eKYCPH API: POST /begin-ekyc-reuse
eKYCPH API --> User: Send OTP via SMS
eKYCPH API --> Client App: Return Session ID

Client App --> eKYCPH API: POST /authenticate-ekyc-reuse
eKYCPH API --> Client App: Return eKYC record + Session ID

Client App --> User: Display eKYC data for confirmation
User --> Client App: Confirm identity

Client App --> eKYCPH API: POST /confirm-ekyc-reuse
eKYCPH API --> Client App: Return final Session ID
  

---

4. Authentication

API Key Authentication

⚠️ Important: All API requests must include an API key in the X-Gravitee-API-Key header.

POST /ekycph/v1/partner-management/api/begin-ekyc-reuse HTTP/1.1
Host: api.ekycph.com
X-Gravitee-API-Key: <your-api-key>
Content-Type: application/json

{
  "phone": "+639123456789",
  "provider_name": "ExampleProvider"
}
  

You can get the API key from the eKYCPH Partner Console:

1. Go to Partner Console
2. Click on the Manage button for your partner you would like to get an API key for
3. Click on Create API Key
4. Copy and paste the API key into your application

---

5. API Reference Guide

You can find the API Reference guide at: https://api.ekyc.ph/v1/partner-management/swagger/index.html