Reference Data

Use reference endpoints for accepted countries, states, provinces, entity types, and industries.

Reference data endpoints return the values B2 Systems accepts for application fields.

Use these endpoints instead of hardcoding values in your CRM integration.

Endpoints

GET /v1/reference/countries
GET /v1/reference/states
GET /v1/reference/provinces
GET /v1/reference/entity-types
GET /v1/reference/industries

Countries

B2 Systems currently supports United States and Canada.

Use the country label when possible:

  • United States
  • Canada

Accepted country aliases include US, USA, and CA. When used as a country, CA means Canada.

States and Provinces

Use state_region for U.S. states, District of Columbia, supported U.S. territories, Canadian provinces, and Canadian territories.

Examples:

  • FL
  • DC
  • PR
  • ON
  • QC

When possible, also send country so abbreviations can be interpreted correctly.

Entity Types

Use GET /v1/reference/entity-types for accepted type_of_entity values.

Common aliases such as LLC, Corp, Inc, and S Corp may be accepted, but using the reference id is preferred.

Industries

Use GET /v1/reference/industries for accepted industry values.

Industries may include aliases, but using the returned id or label is preferred.

Industry responses can include risk_category. This is informational reference data used by B2 Systems for grading and matching configuration.

Caching

Reference data can be cached, but refresh it periodically. B2 Systems may add or update supported values over time.

Unknown Values

B2 Systems normalizes common aliases before matching. Examples include country aliases such as US and USA, state codes such as FL, entity aliases such as LLC and Corp, and configured industry aliases.

If direct TrueSight matching receives an unknown value, the request can still be accepted, but that value may not satisfy funder criteria.

If a dashboard deal is created or reprocessed and an application field cannot be matched to configured reference data, B2 Systems flags the field for review so the dashboard user can choose a supported value.


Did this page help you?