- Docs
- API reference
- Endpoints and schemas
- KYB API
- Use cases
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.
https://api.enigma.com/v2/kyb/?products=phone_numbers,operating_statusReturn 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.
Example
Section titled “Example”This request returns the phone numbers and operating status of each operating location of the matched brand:
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" } }'In the response, trimmed to one operating location, the registered entity
carries only its id, and the brand links to it through
registered_entity_ids; join them by ID.
The operating location has only its id and the two attributes requested.
{ "response_id": "2a1b3c4d-5e6f-7890-abcd-ef1234567890", "risk_summary": { "tasks": [] }, "data": { "registered_entities": [{ "id": "4dccd7a5-790c-c4d1-0000-108000000000" }], "brands": [ { "id": "5f53e079-c66a-487e-8a9d-08efc39652ee", "registered_entity_ids": ["4dccd7a5-790c-c4d1-0000-108000000000"], "operating_locations": [ { "id": "20e8d448-f6c7-4854-9855-f8367b97b097", "phone_numbers": [{ "phone_number": "+12125550100" }], "operating_status": "Open" } ] } ] }}Parameters
Section titled “Parameters”x-api-keyRequiredYour API key. Send it from your server only. See Authentication.
productsRequiredAny add-on attribute,
watchlist,tin_verification,ssn_verification, or aregistration.<field>, separated by commas. At least one value. Cannot be combined withpackageorattrs; see Errors.nameRequiredThe business name, as on any request. Matching is unchanged:
top_nandmatch_thresholdapply as on a package request, and strong identifiers improve the match.
All body fields are in Request body, and the rules in Validation.
Response
Section titled “Response”data.registered_entitiesEach match’s
id, plusregistrationsorbankruptcieswhen you name an attribute that adds them. See Attribute-only requests.data.brandsEach match’s
idandregistered_entity_ids, plusoperating_locations(each with itsid) orcard_transactionswhen you name an attribute that adds them. See Operating locations.risk_summary.tasks[][]attop_n=1, unless you listwatchlist,tin_verificationorssn_verification. When you list an add-on task, branch on itsresultas you would on a package request. See Response shape.Show the result values
Task Results watchlistwatchlist_no_hits,watchlist_hits,not_completedtin_verificationtin_verified,tin_not_verified,tin_not_issued,tin_invalid,duplicate,not_completedssn_verificationssn_verified,ssn_not_verified,ssn_not_issued,ssn_invalid,duplicate,not_completed
Before you rely on it
Section titled “Before you rely on it”- Unknown values return
400. Unlikeattrs,productsrejects 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.
Related
Section titled “Related”- Attribute-only requests:
the full definition, with every value
productsaccepts. - How the response changes: the attribute-only response next to the other request forms.