APIs & Services
Matching API
Getting Started
2min
Once you you have submitted a query to the Matching API, you will be returned back a requestId. This requestId will be needed to obtain the matching results.
Once the Matching job has been completed, your matches will fall under three possible sections:
- Unique match: When the match is exact or unique (only one match found) and the match score is more than 90 and less than or equal to 100.
- Possible match: When the match found for a record is more than one & a unique match with score less than 90
- No match: Match is not identified
1
Submit a request and obtain a requestID
2
Submit a statusRequest and wait until this returns a status of Matched Results Available
3
Get results (page if you have to)
4
(Optional) Find further information on your matches by using the Profile API
The API has a 6MB limitation per HTTP POST Request.
Updated 28 Jun 2024
Did this page help you?