- Docs
- API reference
- Endpoints and schemas
- KYB API
- Request options
Packages
Choose between the identify and verify packages: the standard tasks each runs and the registration fields each returns.
A package decides which standard tasks Enigma runs on the matched business and
which registration fields come back. Set it with the package query parameter
on POST /v2/kyb/. Both
packages match the business the same way; verify adds three standard tasks
and five registration fields. You pay for the package and the add-ons you
request, so request only the data you need.
To run more checks or return more data on top of a package, request add-ons. To return only the attributes you name, with no package and no standard tasks, send an attribute-only request.
Example
Section titled “Example”identify matches the business and checks its name and address with four
standard tasks, and returns registrations without the five fields that only
verify returns.
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" } }'verify runs all seven standard tasks, including person_verification for the
submitted person, and returns each registration with its status.
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" } }'What each package includes
Section titled “What each package includes”Both packages return the same registered entity, brand and registered person fields. They differ in the standard tasks they run and in five registration fields.
| Standard task | identify |
verify |
|---|---|---|
name_verification |
Yes | Yes |
sos_name_verification |
Yes | Yes |
address_verification |
Yes | Yes |
sos_address_verification |
Yes | Yes |
domestic_registration |
No | Yes |
person_verification |
No | Yes |
verification_tier |
No | Yes |
| Registration field | identify |
verify |
|---|---|---|
jurisdiction_type |
No | Yes |
home_jurisdiction_state |
No | Yes |
status |
No | Yes |
sub_status |
No | Yes |
status_detail |
No | Yes |
Tasks run only when top_n=1, the default; see
When top_n is above 1.
For what each task checks, see
Tasks by package. For every
field, see Registered entities
and Brands.
Choose a package
Section titled “Choose a package”Both packages match the business the same way, so the choice turns on whether
you need registration standing. verify returns the registration status,
which identify leaves out. It also returns the verification tier, which you do
not request; see
When it runs.
When to choose identify
Section titled “When to choose identify”Choose identify when you need to confirm that a business exists and matches
what you sent, and you do not need registration status.
- Marketplace seller onboarding. Match a seller’s trading name to the registered entity behind it, and check the name and address.
- B2B SaaS onboarding. Confirm a customer is a real business, for fraud prevention and data quality.
- Data enrichment and pre-fill. Add registration, industry and location data to your own records or onboarding forms.
When to choose verify
Section titled “When to choose verify”Choose verify when you need to know whether the business is registered and in
good standing in its home state.
- Payment processing. Card networks and acquiring banks often require an active state registration.
- Business banking. Record registration standing for regulatory audits when you open an account.
- Lending. Check whether a business is dissolved or suspended.
Set the package
Section titled “Set the package”- The values are
identifyandverify. Any other value returns400. - The value is not case-sensitive:
VERIFYworks. - With neither
packagenorproducts, the request runsverify. - Set
packageexplicitly in production rather than relying on the default. packagecannot be combined withproducts; see Attribute-only requests.
Verification tier
Section titled “Verification tier”The verification tier Beta is
part of the verify package, not an add-on. See
When it runs for
the requests that return it and how it is enabled.
Related
Section titled “Related”- Add-ons: the tasks and attributes you can request on top of either package.
POST /v2/kyb/: every query parameter and body field.- Verify a business: a complete request and response for each package.
- How checks work: what each standard task checks, and its results.
- Registered entities: the registration fields each package returns.