ReferencesControllerV2
Retrieve a list of state options from the database. Note: The response includes a structured collection of states based on predefined configurations.
Specifies the unique code of a country. If provided, the response is filtered to return only state options for that country; otherwise, all state options are returned.
Returns a list of state types successfully.
Unauthorized: User does not have the required role or access.
Internal Server Error: This could be due to system errors. Please contact support for assistance.
GET /api/demographics/v2/References/StateOptions HTTP/1.1
Host:
Accept: */*
{
"content": [
{
"stateCode": "AL",
"stateName": "Alabama",
"isDisplayed": true,
"countryCode": "US"
}
]
}Retrieve a list of company types from the database.
Specifies the unique code of a country. If provided, the response returns only company types for that country; otherwise, all company types are returned. Default: "US".
Returns a list of company types successfully.
Unauthorized: User does not have the required role or access.
Internal Server Error: This could be due to system errors. Please contact support for assistance
GET /api/demographics/v2/References/CompanyTypes HTTP/1.1
Host:
Accept: */*
{
"content": [
{
"id": 4,
"type": "NP",
"legalIdentifiersRequired": true,
"description": "Non profit/tax exempt",
"countryCode": "US"
}
]
}Retrieve a list of legal identifier types from the database.
Country Code used to filter legal identifier types. If provided, only legal identifier types for that country are returned; otherwise, all available legal identifier types are included.
Returns a list of legal identifier types successfully.
Unauthorized: User does not have the required role or access.
Internal Server Error: This could be due to system errors. Please contact support for assistance
GET /api/demographics/v2/References/LegalIdentifierTypes HTTP/1.1
Host:
Accept: */*
{
"content": [
{
"type": "TIN",
"description": "TaxIDNumber/EIN",
"isVatIdentifier": true,
"countryCode": "US"
}
]
}Was this helpful?