|

Retrieve detailed insights for a business onboarding

get/businesses/{fp_bid}/onboardings/{onboarding_id}/details
Preview
Locked
Retrieve business insights including names, registrations, filings, and watchlist hits

Request

Path parameters

fp_bid·

string

onboarding_id·

string

Response

Aggregated insights from business verification (KYB).

Contains all verification results for a business entity, including name verification, registration records, associated people, watchlist screening, and address details.

addresses·

array of objects

Addresses associated with the business, both submitted and discovered.
address_line1·

optional string

Primary street address line.
address_line2·

optional string

Secondary address line (suite, unit, etc.).
city·

optional string

City name.
cmra·

optional boolean

Whether this address is a Commercial Mail Receiving Agency (CMRA), such as a UPS Store or similar mailbox service.

deliverable·

optional boolean

Whether this address is deliverable by USPS.
latitude·

optional number

Latitude coordinate of the address.
longitude·

optional number

Longitude coordinate of the address.
postal_code·

optional string

Postal or ZIP code.
property_type·

optional string

Property type classification (e.g. commercial, residential).
sources·

optional string

Sources where this address was found during verification.
state·

optional string

U.S. state or region.
submitted·

optional boolean

Whether this address was submitted as part of the onboarding flow.
verified·

optional boolean

Whether this address was verified.
details·

optional object

General details about the business such as formation info, TIN, phone, and website.

entity_type·

optional string

The type of business entity (e.g. LLC, Corporation), if available.
formation_date·

optional string

Date the business was formed, if available.
formation_state·

optional string

U.S. state (or jurisdiction) where the business was formed, if available.

phone_numbers·

array of objects

Phone numbers associated with the business and their verification status.

tin·

optional object

Information about the business's Taxpayer Identification Number (TIN).
website·

optional object

Website associated with the business and its verification status.
names·

array of objects

Business names (DBA and legal) that were submitted or discovered during verification, along with their verification status.

kind·

optional string

The type of business name, e.g. "dba" or "legal".
name·

optional string

The business name.
sources·

optional string

Sources where this name was found during verification. Does not include watchlist information.

sub_status·

optional string

A more granular verification status for this name.
submitted·

boolean

Whether this name was submitted as part of the onboarding flow (as opposed to being discovered during verification).

verified·

optional boolean

Whether this name was verified. None if verification was not attempted.

people·

array of objects

People associated with the business, including submitted beneficial owners and individuals discovered through public records.

association_verified·

optional boolean

Whether this person's association with the business was verified. None if verification was not attempted.

name·

optional string

Full name of the person.
role·

optional string

The person's role at the business (e.g. officer, director, beneficial owner).

sources·

optional string

Sources where this person was found during verification.
submitted·

boolean

Whether this person was submitted as part of the onboarding flow (as opposed to being discovered through public records or other sources).

registrations·

array of objects

Governmental registration records found for the business.
addresses·

array of strings

Addresses listed on the registration.
entity_type·

optional string

Entity type as listed on the registration (e.g. LLC, Corporation).
file_number·

optional string

The filing or registration number assigned by the registering body.
jurisdiction·

optional string

The jurisdiction under which the business is registered.
name·

optional string

The business name as it appears on the registration.
officers·

array of objects

Officers listed on the registration.
registered_agent·

optional string

Name of the registered agent on file.
registration_date·

optional string

Date the registration was filed.
source·

optional string

The source or agency that provided this registration record.
state·

optional string

U.S. state where the registration was filed.
status·

optional string

Current status of the registration (e.g. active, inactive).
sub_status·

optional string

More granular status of the registration.
watchlist·

optional object

Watchlist screening results for the business and its associated people.
business·

array of objects

Watchlist screening results for business names.
hit_count·

optional integer

Total number of watchlist hits across all screened entities.
people·

array of objects

Watchlist screening results for people associated with the business.
GET /businesses/{fp_bid}/onboardings/{onboarding_id}/details
1curl https://api.onefootprint.com/businesses/{fp_bid}/onboardings/{onboarding_id}/details \
2  -u sk_test_xxxxx:
Response example
{
  "addresses": [
    {
      "address_line1": "Lorem ipsum dolor",
      "address_line2": "Lorem ipsum dolor",
      "city": "Lorem ipsum dolor",
      "cmra": true,
      "deliverable": true,
      "latitude": 1,
      "longitude": 1,
      "postal_code": "Lorem ipsum dolor",
      "property_type": "Lorem ipsum dolor",
      "sources": "Lorem ipsum dolor",
      "state": "Lorem ipsum dolor",
      "submitted": true,
      "verified": true
    },
    {
      "address_line1": "Lorem ipsum dolor",
      "address_line2": "Lorem ipsum dolor",
      "city": "Lorem ipsum dolor",
      "cmra": true,
      "deliverable": true,
      "latitude": 1,
      "longitude": 1,
      "postal_code": "Lorem ipsum dolor",
      "property_type": "Lorem ipsum dolor",
      "sources": "Lorem ipsum dolor",
      "state": "Lorem ipsum dolor",
      "submitted": true,
      "verified": true
    }
  ],
  "details": {
    "entity_type": "Lorem ipsum dolor",
    "formation_date": "Lorem ipsum dolor",
    "formation_state": "Lorem ipsum dolor",
    "phone_numbers": [
      {
        "phone": "Lorem ipsum dolor",
        "submitted": true,
        "verified": true
      },
      {
        "phone": "Lorem ipsum dolor",
        "submitted": true,
        "verified": true
      }
    ],
    "tin": {
      "potential_match": "Lorem ipsum dolor",
      "tin": "Lorem ipsum dolor",
      "verified": true
    },
    "website": {
      "url": "Lorem ipsum dolor",
      "verified": true
    }
  },
  "names": [
    {
      "kind": "Lorem ipsum dolor",
      "name": "Lorem ipsum dolor",
      "sources": "Lorem ipsum dolor",
      "sub_status": "Lorem ipsum dolor",
      "submitted": true,
      "verified": true
    },
    {
      "kind": "Lorem ipsum dolor",
      "name": "Lorem ipsum dolor",
      "sources": "Lorem ipsum dolor",
      "sub_status": "Lorem ipsum dolor",
      "submitted": true,
      "verified": true
    }
  ],
  "people": [
    {
      "association_verified": true,
      "name": "Lorem ipsum dolor",
      "role": "Lorem ipsum dolor",
      "sources": "Lorem ipsum dolor",
      "submitted": true
    },
    {
      "association_verified": true,
      "name": "Lorem ipsum dolor",
      "role": "Lorem ipsum dolor",
      "sources": "Lorem ipsum dolor",
      "submitted": true
    }
  ],
  "registrations": [
    {
      "addresses": [
        "Lorem ipsum dolor",
        "Lorem ipsum dolor"
      ],
      "entity_type": "Lorem ipsum dolor",
      "file_number": "Lorem ipsum dolor",
      "jurisdiction": "Lorem ipsum dolor",
      "name": "Lorem ipsum dolor",
      "officers": [
        {
          "name": "Lorem ipsum dolor",
          "roles": "Lorem ipsum dolor"
        },
        {
          "name": "Lorem ipsum dolor",
          "roles": "Lorem ipsum dolor"
        }
      ],
      "registered_agent": "Lorem ipsum dolor",
      "registration_date": "Lorem ipsum dolor",
      "source": "Lorem ipsum dolor",
      "state": "Lorem ipsum dolor",
      "status": "Lorem ipsum dolor",
      "sub_status": "Lorem ipsum dolor"
    },
    {
      "addresses": [
        "Lorem ipsum dolor",
        "Lorem ipsum dolor"
      ],
      "entity_type": "Lorem ipsum dolor",
      "file_number": "Lorem ipsum dolor",
      "jurisdiction": "Lorem ipsum dolor",
      "name": "Lorem ipsum dolor",
      "officers": [
        {
          "name": "Lorem ipsum dolor",
          "roles": "Lorem ipsum dolor"
        },
        {
          "name": "Lorem ipsum dolor",
          "roles": "Lorem ipsum dolor"
        }
      ],
      "registered_agent": "Lorem ipsum dolor",
      "registration_date": "Lorem ipsum dolor",
      "source": "Lorem ipsum dolor",
      "state": "Lorem ipsum dolor",
      "status": "Lorem ipsum dolor",
      "sub_status": "Lorem ipsum dolor"
    }
  ],
  "watchlist": {
    "business": [
      {
        "hits": [
          {
            "agency": "Lorem ipsum dolor",
            "agency_abbr": "Lorem ipsum dolor",
            "agency_information_url": "Lorem ipsum dolor",
            "agency_list_url": "Lorem ipsum dolor",
            "entity_addresses": [
              "Lorem ipsum dolor",
              "Lorem ipsum dolor"
            ],
            "entity_aliases": [
              "Lorem ipsum dolor",
              "Lorem ipsum dolor"
            ],
            "entity_name": "Lorem ipsum dolor",
            "list_country": "Lorem ipsum dolor",
            "list_name": "Lorem ipsum dolor",
            "url": "Lorem ipsum dolor"
          },
          {
            "agency": "Lorem ipsum dolor",
            "agency_abbr": "Lorem ipsum dolor",
            "agency_information_url": "Lorem ipsum dolor",
            "agency_list_url": "Lorem ipsum dolor",
            "entity_addresses": [
              "Lorem ipsum dolor",
              "Lorem ipsum dolor"
            ],
            "entity_aliases": [
              "Lorem ipsum dolor",
              "Lorem ipsum dolor"
            ],
            "entity_name": "Lorem ipsum dolor",
            "list_country": "Lorem ipsum dolor",
            "list_name": "Lorem ipsum dolor",
            "url": "Lorem ipsum dolor"
          }
        ],
        "screened_entity_name": "Lorem ipsum dolor"
      },
      {
        "hits": [
          {
            "agency": "Lorem ipsum dolor",
            "agency_abbr": "Lorem ipsum dolor",
            "agency_information_url": "Lorem ipsum dolor",
            "agency_list_url": "Lorem ipsum dolor",
            "entity_addresses": [
              "Lorem ipsum dolor",
              "Lorem ipsum dolor"
            ],
            "entity_aliases": [
              "Lorem ipsum dolor",
              "Lorem ipsum dolor"
            ],
            "entity_name": "Lorem ipsum dolor",
            "list_country": "Lorem ipsum dolor",
            "list_name": "Lorem ipsum dolor",
            "url": "Lorem ipsum dolor"
          },
          {
            "agency": "Lorem ipsum dolor",
            "agency_abbr": "Lorem ipsum dolor",
            "agency_information_url": "Lorem ipsum dolor",
            "agency_list_url": "Lorem ipsum dolor",
            "entity_addresses": [
              "Lorem ipsum dolor",
              "Lorem ipsum dolor"
            ],
            "entity_aliases": [
              "Lorem ipsum dolor",
              "Lorem ipsum dolor"
            ],
            "entity_name": "Lorem ipsum dolor",
            "list_country": "Lorem ipsum dolor",
            "list_name": "Lorem ipsum dolor",
            "url": "Lorem ipsum dolor"
          }
        ],
        "screened_entity_name": "Lorem ipsum dolor"
      }
    ],
    "hit_count": 1,
    "people": [
      {
        "hits": [
          {
            "agency": "Lorem ipsum dolor",
            "agency_abbr": "Lorem ipsum dolor",
            "agency_information_url": "Lorem ipsum dolor",
            "agency_list_url": "Lorem ipsum dolor",
            "entity_addresses": [
              "Lorem ipsum dolor",
              "Lorem ipsum dolor"
            ],
            "entity_aliases": [
              "Lorem ipsum dolor",
              "Lorem ipsum dolor"
            ],
            "entity_name": "Lorem ipsum dolor",
            "list_country": "Lorem ipsum dolor",
            "list_name": "Lorem ipsum dolor",
            "url": "Lorem ipsum dolor"
          },
          {
            "agency": "Lorem ipsum dolor",
            "agency_abbr": "Lorem ipsum dolor",
            "agency_information_url": "Lorem ipsum dolor",
            "agency_list_url": "Lorem ipsum dolor",
            "entity_addresses": [
              "Lorem ipsum dolor",
              "Lorem ipsum dolor"
            ],
            "entity_aliases": [
              "Lorem ipsum dolor",
              "Lorem ipsum dolor"
            ],
            "entity_name": "Lorem ipsum dolor",
            "list_country": "Lorem ipsum dolor",
            "list_name": "Lorem ipsum dolor",
            "url": "Lorem ipsum dolor"
          }
        ],
        "screened_entity_name": "Lorem ipsum dolor"
      },
      {
        "hits": [
          {
            "agency": "Lorem ipsum dolor",
            "agency_abbr": "Lorem ipsum dolor",
            "agency_information_url": "Lorem ipsum dolor",
            "agency_list_url": "Lorem ipsum dolor",
            "entity_addresses": [
              "Lorem ipsum dolor",
              "Lorem ipsum dolor"
            ],
            "entity_aliases": [
              "Lorem ipsum dolor",
              "Lorem ipsum dolor"
            ],
            "entity_name": "Lorem ipsum dolor",
            "list_country": "Lorem ipsum dolor",
            "list_name": "Lorem ipsum dolor",
            "url": "Lorem ipsum dolor"
          },
          {
            "agency": "Lorem ipsum dolor",
            "agency_abbr": "Lorem ipsum dolor",
            "agency_information_url": "Lorem ipsum dolor",
            "agency_list_url": "Lorem ipsum dolor",
            "entity_addresses": [
              "Lorem ipsum dolor",
              "Lorem ipsum dolor"
            ],
            "entity_aliases": [
              "Lorem ipsum dolor",
              "Lorem ipsum dolor"
            ],
            "entity_name": "Lorem ipsum dolor",
            "list_country": "Lorem ipsum dolor",
            "list_name": "Lorem ipsum dolor",
            "url": "Lorem ipsum dolor"
          }
        ],
        "screened_entity_name": "Lorem ipsum dolor"
      }
    ]
  }
}