post https://sandbox.crimescan.ai/v1/pep-check/search
Overview
The Politically Exposed Person (PEP) API provides a two-step asynchronous service for verifying whether an individual is identified as a politically exposed person. It allows secure, reliable, and scalable checks using a unique search_id for result retrieval.
Getting Started
To use the PEP API:
- Obtain an API Key – You need a valid API key to access the API.
- Initiate a Search Request – Send a POST request to the /pep-check/search endpoint with the required parameters. The response will include a search_id.
- Fetch Results – Use the search_id to fetch results from the /pep-check/results endpoint after a short delay.
Authentication
- The PEP API uses API Key Authentication.
- Include your API key in the request headers using
Authorization: Bearer xxxxxxxxxxxxxxxxxxxxxxxxxxxxx
- If an invalid or missing API key is used, the API returns an HTTP 401 Unauthorized error.
API Endpoints
- Initiate PEP Search (Step 1)
- Method: POST
- Endpoint: /pep-check/search
- Description: Initiates a PEP check. Returns a search_id.
- Request Body Example:
{"pan_no":"ACHPIXXXXB"}
{"search_id":"5083118ea5fa493da75ba8XXXXXXXXXXX"}
- Fetch PEP Results (Step 2)
- Method: POST
- Endpoint: /pep-check/results
- Description: Fetches the results for a previously initiated PEP search.