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. The requestId will be needed to obtain your Matching results.

Once the Matching job has been completed, your matches will fall under three possible sections:

  • Unique match: A single match with a score between 87 and 100
  • Possible match: Multiple matches found, or a single match with a score between 73 and 86
  • No match: No suitable match found
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 02 May 2025
Doc contributor
Doc contributor
Doc contributor
Did this page help you?
PREVIOUS
Matching API
NEXT
Example queries
Docs powered by Archbee