v1
latestOpenAPI 3.1.02026-07-244015.2 KBMatch Endpoint - Single Transaction Calls
Query parameters
The person's full name. Could include first, middle, last, and suffix. Example: "Eduardo F Lopez Jr". Do not include this parameter if the parameters for individual name components are included.
The complete street address (postal address without city, state, ZIP). Example: "101 W Main St S Apt 12". Do not include this parameter if the parameters for individual address components are included.
The person's first name. Examples: "Eduardo", "Felicia". Do not include this parameter if the "name" parameter (the unparsed name) is included.
The person's middle name or middle initial. Examples: "Kyu", "K", "John", "J". Do not include this parameter if the "name" parameter (the unparsed name) is included.
The person's last name. Examples: "Lopez", "Nguyen". Do not include this parameter if the "name" parameter (the unparsed name) is included.
The person's generational name suffix. Examples: "Jr", "Sr", "II". Do not include this parameter if the "name" parameter (the unparsed name) is included.
The street number in a postal address. Examples: "10", "123", "3333". Do not include this parameter if the "streetAddress" parameter (the unparsed street address) is included.
The street pre-directional in a postal address. Examples: "N", "S", "E", "W". Do not include this parameter if the "streetAddress" parameter (the unparsed street address) is included.
The street name in a postal address. Examples: "Main", "Finley", "Hillsdale". Do not include this parameter if the "streetAddress" parameter (the unparsed street address) is included.
The street suffix in a postal address. Example: St, Dr, Rd, Blvd. Do not include this parameter if the "streetAddress" parameter (the unparsed street address) is included.
The street post-directional in a postal address. Example: N, S, E, W. Do not include this parameter if the "streetAddress" parameter (the unparsed street address) is included.
The secondary unit designator in a postal address. Example: Apt, Ste, Fl, Unit. Do not include this parameter if the "streetAddress" parameter (the unparsed street address) is included.
The secondary number in a postal address. Does not include the unit designator text (for example, Apt., or #). Example: 12A, 4, 105. Do not include this parameter if the "streetAddress" parameter (the unparsed street address) is included.
The city. Example: Los Angeles, Seattle, Paris.
The 2-character standard abbreviation. Example: CA, TN, CO, CT.
The ZIP/postal code (5 digit, 9 digit, or 11 digit). Example: 95010, 10004-4357
The plaintext email address.
For U.S. phone numbers, the complete phone number that includes the 10 digits without delimiters. Example: 6305558052
The maximum number of desired matches to be returned from the API. The default is 1, which causes the API to return only the best match, if available. When limit is set to a value greater than 1, the API will return up to limit matches in order of decreasing match confidence. All matches must exceed the minimum match threshold to be returned, so it is possible that fewer than limit matches will be returned on a given request. An integer between 1 (default) and 10 (maximum), inclusive.
Indicates whether a strict match of all parameters is required. When this is set to false, the service will blank out any invalid data and attempt a match with the remaining parameters. Default: true
Response
200
Example response
{
"entity": {
"abilitec": {
"consumerLink": "003YUS02XKRLMYCQ",
"addressLink": "003YUS136XH7B3BT",
"householdLink": "003YUS18Y4Y5X9WT"
},
"matchMetadata": {
"matchComponents": [
"name"
],
"matchConfidence": "8",
"nameMatchIntegrity": "complete"
}
}
}