ReferencesControllerV2

Retrieves a list of State Options

get

This endpoint retrieves a list of state options from the database based on the specified country code else retrieves all state options. The response includes a collection of states based on predefined configurations and criteria.

Query parameters

countryCodestringOptional

CountryCode used to filter states.

Header parameters

exchangeIdstringOptional

Correlation Id for the request

Responses

200

Returns a list of state types successfully.

text/plainapplication/jsontext/json

401

Unauthorized: User does not have the required role or access.

text/plainapplication/jsontext/json

500

Internal Server Error: This could be due to system errors. Please contact support for assistance.

get

HTTPcURLJavaScriptPython

GET /api/demographics/v2/References/StateOptions HTTP/1.1
Host: localhost:5000
Accept: */*

{
  "content": [
    {
      "stateCode": "AL",
      "stateName": "Alabama",
      "isDisplayed": true,
      "countryCode": "US"
    }
  ]
}

Retrieves a list of Company Types

get

This endpoint retrieves a list of company types from the database based on the specified country code else retrieves all company types, which are filtered by a specific country code "US" (Default).

Query parameters

countryCodestringOptional

CountryCode used to filter states.

Header parameters

exchangeIdstringOptional

Correlation Id for the request

Responses

200

Returns a list of company types successfully.

text/plainapplication/jsontext/json

401

Unauthorized: User does not have the required role or access.

text/plainapplication/jsontext/json

500

Internal Server Error: This could be due to system errors. Please contact support for assistance

get

HTTPcURLJavaScriptPython

GET /api/demographics/v2/References/CompanyTypes HTTP/1.1
Host: localhost:5000
Accept: */*

{
  "content": [
    {
      "id": 4,
      "type": "NP",
      "legalIdentifiersRequired": true,
      "description": "Non profit/tax exempt",
      "countryCode": "US"
    }
  ]
}

Retrieves a list of Legal Identifier Types

get

This endpoint retrieves a list of legal identifier types, optionally filtered by a given country code. If no country code is provided, it returns all available identifier types.

Query parameters

countryCodestringOptional

CountryCode used to filter legal identifier types.

Header parameters

exchangeIdstringOptional

Correlation Id for the request

Responses

200

Returns a list of legal identifier types successfully.

text/plainapplication/jsontext/json

401

Unauthorized: User does not have the required role or access.

text/plainapplication/jsontext/json

500

Internal Server Error: This could be due to system errors. Please contact support for assistance

get

HTTPcURLJavaScriptPython

GET /api/demographics/v2/References/LegalIdentifierTypes HTTP/1.1
Host: localhost:5000
Accept: */*

{
  "content": [
    {
      "type": "TIN",
      "description": "TaxIDNumber/EIN",
      "isVatIdentifier": true,
      "countryCode": "US"
    }
  ]
}