SOS Search

Request and Response Object Structures.

{
  "name": string,
  "state":string,
  "callback_url": [string]
}

{
    "id": integer,
    "status": string,
    "name": string,
    "address": string,
    "states": string,
    "created_at": string
}

Sample Requests and Responses.

{
    "name": "Microsoft",
    "state":"arkansas"
}

{
    "id": 6,
    "status": "Pending",
    "name": "Microsoft",
    "address": null,
    "callback_url": null,
    "states": "arkansas",
    "created_at": "2023-09-18T10:52:41.189571Z"
}

{
    "name": [
        "This field is required"
    ]
}

{
    "state": [
        "This field is required"
    ]
}

{
    "state": [
        "Invalid Input. Allowed values are : alabama, alabama, alaska, arizona, arkansas, california, colorado, connecticut, delaware, district of columbia, florida, florida, hawaii, hawaii, idaho, illinois, indiana, iowa, kansas, louisiana, maine, maryland, massachusets, michigan, minnesota, mississippi, missouri, montana, nebraska, nevada, new hampshire, new jersey, new mexico, newyork, north carolina, north dakota, ohio, oklahoma, oregon, pennsylvania, rhodeisland, south carolina, south dakota, tennessee, utah, washington, west virginia, west virginia"
    ]
}

{
    "detail": "Authentication credentials were not provided."
}

{
    "detail": "Credit limit reached! For assistance, please contact the support"
}

{
    "detail": "Invalid token."
}

Request Parameters:

Field Name	Field Type	Mandatory/Optional	Description
name	String	Mandatory	Business Name to search
state	String	Mandatory	Predefined state value as defined below
callback_url	List of String	Optional	A Valid endpoint which should return a success status 2xx. Once the result is available we will post it to the endpoint. Read more on Webhooks

alabama, alabama, alaska, arizona, arkansas, california, colorado, connecticut, delaware, district of columbia, florida, florida, hawaii, hawaii, idaho, illinois, indiana, iowa, kansas, louisiana, maine, maryland, massachusets, michigan, minnesota, mississippi, missouri, montana, nebraska, nevada, new hampshire, new jersey, new mexico, newyork, north carolina, north dakota, ohio, oklahoma, oregon, pennsylvania, rhodeisland, south carolina, south dakota, tennessee, utah, washington, west virginia, west virginia