Name Lookup Request

Submit a business name availability check for a US state. The request is processed asynchronously; poll GET endpoints or use webhooks for results.
id in the response is the request UUID used with GET by ID.


Credit Message Error

  • {"code": "credit_message", "message": "Credit limit reached! For assistance, please contact the support"}

Request and Response Object Structures.

{
  "business_name": "string",
  "state": "string",
  "webhook_urls": ["string"]
}
{
    "success_message": "Name availability request created successfully",
    "data": {
        "id": "0199c0a1-2b3d-7e8f-9a0b-1c2d3e4f5a6b",
        "status": "Pending",
        "name_available": null,
        "business_name": "Acme Analytics",
        "webhook_urls": ["https://example.com/hooks/name-lookup"],
        "state": "california",
        "created_at": "2026-08-18T10:16:14.123456Z",
        "created_by": "[email protected]"
    },
    "success": true
}

Sample Requests and Responses.

{
  "business_name": "Acme Analytics",
  "state": "california",
  "webhook_urls": ["https://example.com/hooks/name-lookup"]
}
{
    "errors": [
        {
            "code": "business_name",
            "message": "This field is required."
        }
    ],
    "data": null,
    "success": false
}
{
    "errors": [
        {
            "code": "business_name",
            "message": "Name contains invalid characters. Only a-z, A-Z, 0-9, spaces, &, and - are allowed. Additionally, the input must contain at least one alphabet character."
        }
    ],
    "data": null,
    "success": false
}
{
    "errors": [
        {
            "code": "state",
            "message": "Please provide a valid state. Available states are: alabama, alaska, arizona, ..."
        }
    ],
    "data": null,
    "success": false
}
{
    "errors": [
        {
            "code": "webhook_urls",
            "message": "Max 3 Webhook URLs allowed."
        }
    ],
    "data": null,
    "success": false
}
{
    "detail": "Credit limit reached! For assistance, please contact the support"
}
{
    "detail": "Invalid token."
}
{
    "detail": "Authentication credentials were not provided."
}

Request Parameters:

Field NameField TypeMandatory/OptionalDescription
business_nameStringMandatory3–225 characters. Letters, digits, spaces, &, and - only; at least one letter.
stateStringMandatoryUS state key (spaces accepted; stored as the underscored crawler key, e.g. california, newyork, westvirginia).
webhook_urlsArray of stringsOptionalCompletion callback URLs. Maximum 3.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required
length ≥ 1

Business / entity name to check (3–225 chars; a-z, A-Z, 0-9, spaces, &, -)

string
required
length ≥ 1

US state key (e.g. california, newyork, westvirginia)

webhook_urls
array of strings

Optional webhook URLs for completion notifications (max 3)

webhook_urls
Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json