Enrich a business profile
Fetch enriched profile data. Requires a valid email address. This service is offered in collaboration with Clearbit.
To access this endpoint using an access token
you’ll need to specify the /profile-enrichment.read
scope.
GET
/enrichment/profile
|
|
The request completed successfully.
{
"business": {
"address": {
"addressLine1": "123 Main Street",
"addressLine2": "Apt 302",
"city": "Boulder",
"country": "US",
"postalCode": "80301",
"stateOrProvince": "CO"
},
"email": "jordan.lee@classbooker.dev",
"industryCodes": {
"naics": "713940",
"sic": "7991"
},
"legalBusinessName": "string",
"phone": {
"countryCode": "1",
"number": "8185551212"
},
"website": "string"
}
}
Response headers
x-request-id
string
<uuid>
required
A unique identifier used to trace requests.
The request contained missing or expired authentication.
Response headers
x-request-id
string
<uuid>
required
A unique identifier used to trace requests.
The user is not authorized to make the request.
Response headers
x-request-id
string
<uuid>
required
A unique identifier used to trace requests.
The requested resource was not found.
Response headers
x-request-id
string
<uuid>
required
A unique identifier used to trace requests.
Request was refused due to rate limiting.
Response headers
x-request-id
string
<uuid>
required
A unique identifier used to trace requests.
The request failed due to an unexpected error.
Response headers
x-request-id
string
<uuid>
required
A unique identifier used to trace requests.
The request failed because a downstream service failed to respond.
Response headers
x-request-id
string
<uuid>
required
A unique identifier used to trace requests.
Headers
x-moov-version
string
API version
Specify an API version.
API versioning follows the format vYYYY.QQ.BB
, where
YYYY
is the yearQQ
is the two-digit month for the first month of the quarter (e.g., 01, 04, 07, 10)BB
is the build number, starting at.01
, for subsequent builds in the same quarter.- For example,
v2024.01.00
is the initial release of the first quarter of 2024.
- For example,
The latest
version represents the most recent development state. It may include breaking changes and should be treated as a beta release.
Default:
v2024.01.00
Query parameters
string
required
Response
application/json
business
object
Show child attributes
address
object
Show child attributes
addressLine1
string
<=60 characters
required
city
string
<=32 characters
required
country
string
<=2 characters
required
postalCode
string
<=5 characters
required
stateOrProvince
string
<=2 characters
required
addressLine2
string
<=32 characters
string<email>
<=255 characters
industryCodes
object
Show child attributes
naics
string
[2 to 6] characters
sic
string
4 characters
legalBusinessName
string
phone
object
Show child attributes
countryCode
string
<=1 characters
number
string
<=10 characters
website
string