Skip to content
Console(opens in a new tab)

Verify a business

Match a business to Enigma's records and run the standard tasks of the verify or identify package.

POSThttps://api.enigma.com/v2/kyb/?package=verify

Send what you know about a U.S. business. Enigma matches it to a registered entity and a brand, runs the standard tasks of your package against the match, and returns the matched data with a result for each task. This is the base of every business request: like every use case, it is one POST /v2/kyb/ request, and add-ons such as watchlist screening or a TIN check combine in the same call, as in Onboard a business.

This request runs the seven standard verify tasks. The submitted person is checked by person_verification.

cURL
curl --request POST "https://api.enigma.com/v2/kyb/?package=verify" \
--header "x-api-key: $ENIGMA_API_KEY" \
--header "Content-Type: application/json" \
--data '{
"name": "Enigma Technologies",
"website": "https://enigma.com",
"address": {
"street_address1": "245 5th Ave",
"city": "New York",
"state": "NY",
"postal_code": "10016"
},
"person": {
"first_name": "Jane",
"last_name": "Smith"
}
}'
x-api-keyheaderRequired

Your API key. Send it from your server only. See Authentication.

packagequeryDefault verify

verify or identify. Set it explicitly in production. Case-insensitive. See Choose a package.

top_nqueryDefault 1

1. Tasks run only at 1. See When top_n is above 1.

match_thresholdquery

A number from 0 to 1: the minimum match confidence a candidate needs. See Set a match threshold.

attrsquery

Add-on tasks and attributes, run on top of either package. See Add-ons.

namebodyRequired

The business name. Send name, or up to two names, such as a legal name and a trade name. Enigma tries every combination of names and addresses. Only a business name is required, but the tasks check what you send.

addressbodyFor the address tasks

address with street_address1. Without it, both address tasks return address_not_verified.

personbodyFor person_verification

On verify, person_verification always runs, and returns person_not_verified when the request has no person.

Each identifier you add helps Enigma find the right match; see Send strong identifiers. All query parameters are in Query parameters, all body fields in Request body, and the rules in Validation.

risk_summary.tasks[]array

The standard tasks of the package, then any add-on tasks you request. Branch on each task’s result. identify runs only the first four tasks below; verify runs all seven. Find a task by task_name, not by its position. See Tasks by package.

Show the 7 tasks and their results
TaskResults
name_verificationname_exact_match, name_match, name_not_verified
sos_name_verificationname_exact_match, name_match, name_not_verified
address_verificationaddress_exact_match, address_match, address_not_verified
sos_address_verificationaddress_exact_match, address_match, address_not_verified
domestic_registrationdomestic_active, domestic_unknown, domestic_inactive, domestic_not_found
person_verificationperson_match, person_not_verified
verification_tiertier_1, tier_2, tier_3, tier_unknown
data.registered_entitiesarray

The matched registered entity and its registrations. On verify, each registration carries its status. See The registration object.

data.brandsarray

The matched brand, linked to registered entities by ID. See Brands.

response_idstring

The ID of this response. Log it and quote it to Enigma support. See Top-level fields.

This request matches a business and checks its name and address with the four identify tasks.

cURL
curl --request POST "https://api.enigma.com/v2/kyb/?package=identify" \
--header "x-api-key: $ENIGMA_API_KEY" \
--header "Content-Type: application/json" \
--data '{
"name": "Enigma Technologies",
"website": "https://enigma.com",
"address": {
"street_address1": "245 5th Ave",
"city": "New York",
"state": "NY",
"postal_code": "10016"
}
}'

The response has the same shape as the verify response, with four tasks, and registrations without the five fields that only verify returns.

This request sends a legal name and a trade name in the request data wrapper, with primary_name inside it. Enigma tries each name with the address. See The data wrapper.

cURL
curl --request POST "https://api.enigma.com/v2/kyb/?package=verify" \
--header "x-api-key: $ENIGMA_API_KEY" \
--header "Content-Type: application/json" \
--data '{
"data": {
"primary_name": "Enigma Technologies Inc",
"names": ["Enigma Technologies Inc", "Enigma"],
"addresses": [
{
"street_address1": "245 5th Ave",
"city": "New York",
"state": "NY",
"postal_code": "10016"
}
],
"websites": ["https://enigma.com"]
}
}'
  • A 200 is not a verification. 200 means Enigma processed the request, including when nothing matched or a task failed. Read the outcome from data and each task’s result. See Status codes.
  • Join by ID. Even at top_n=1, the returned brand is not always linked to the returned registered entity. See Which record is the match.
  • Set the package explicitly. A request with neither package nor products runs verify. To decide which one you need, see Choose a package.
  • Packages: the tasks and fields each package returns, and how to choose one.
  • Add-ons: every add-on task and attribute you can request on top of a package.
  • How checks work: every task and its results.
  • Onboard a business: verification together with watchlist screening and a TIN check.