Skip to content
Console(opens in a new tab)

Get attributes only

Return the attributes you name for each match, such as phone numbers or operating status, without a package or its standard tasks.

POSThttps://api.enigma.com/v2/kyb/?products=phone_numbers,operating_status

Return only the attributes you name for each match, such as a location’s phone numbers or operating status. Enigma matches the business as usual and returns the id of each match plus your attributes, with no package data and no standard tasks. Use it for enrichment and prefill. To get the same attributes with a package, add them to attrs on a Verify a business request: like every use case, it is one POST /v2/kyb/ request, and add-ons combine.

This request returns the phone numbers and operating status of each operating location of the matched brand:

cURL
curl --request POST "https://api.enigma.com/v2/kyb/?products=phone_numbers,operating_status" \
--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"
}
}'
x-api-keyheaderRequired

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

productsqueryRequired

Any add-on attribute, watchlist, tin_verification, ssn_verification, or a registration.<field>, separated by commas. At least one value. Cannot be combined with package or attrs; see Errors.

namebodyRequired

The business name, as on any request. Matching is unchanged: top_n and match_threshold apply as on a package request, and strong identifiers improve the match.

All body fields are in Request body, and the rules in Validation.

data.registered_entitiesarray

Each match’s id, plus registrations or bankruptcies when you name an attribute that adds them. See Attribute-only requests.

data.brandsarray

Each match’s id and registered_entity_ids, plus operating_locations (each with its id) or card_transactions when you name an attribute that adds them. See Operating locations.

risk_summary.tasks[]array

[] at top_n=1, unless you list watchlist, tin_verification or ssn_verification. When you list an add-on task, branch on its result as you would on a package request. See Response shape.

Show the result values
TaskResults
watchlistwatchlist_no_hits, watchlist_hits, not_completed
tin_verificationtin_verified, tin_not_verified, tin_not_issued, tin_invalid, duplicate, not_completed
ssn_verificationssn_verified, ssn_not_verified, ssn_not_issued, ssn_invalid, duplicate, not_completed
  • Unknown values return 400. Unlike attrs, products rejects a value it does not recognize. See Errors.
  • Misspelled registration fields. An unknown name after registration. is not rejected and returns nothing. Check it against Registration fields.
  • Account enablement. The add-on attributes and tasks you name must be enabled for your account; see Account enablement.