API Reference

API

Response Field Description

FieldTypeDescription
statuscodeIntegerHTTP-like custom response code indicating success (200 = OK).
statusBooleanTrue if transaction was successful
messageStringTransaction result message
reference_idStringUnique identifier used to track the specific request or transaction
client_idStringUnique client reference or session ID generated for the API call. Useful for tracing requests internally
name_2StringThe first name input provided for comparison (e.g., from one data source).
name_1StringThe second name input provided for comparison (e.g., from another data source)
match_scoreIntegerThe similarity score (in percentage) between the two names, based on the matching algorithm
match_statusBooleanIndicates whether the two names are considered a match (true) or not a match (false), based on the predefined threshold
Language
Click Try It! to start a request and see the response here!