# ReferencesControllerV2

## Get state options

> Retrieve a list of state options from the database.> \\
>
> \
> Note: The response includes a structured collection of states based on predefined configurations.

```json
{"openapi":"3.0.1","info":{"title":"External US Onboarding Workflow","version":"0.0.1"},"paths":{"/api/demographics/v2/References/StateOptions":{"get":{"tags":["ReferencesControllerV2"],"summary":"Get state options","description":"Retrieve a list of state options from the database.\r\n\r\nNote: The response includes a structured collection of states based on predefined configurations.","parameters":[{"name":"countryCode","in":"query","description":"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.","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns a list of state types successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MerchantDemographics.References.Api.Models.StateOptionCollection"}}}},"401":{"description":"Unauthorized: User does not have the required role or access.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"}}}},"500":{"description":"Internal Server Error: This could be due to system errors. Please contact support for assistance."}}}}},"components":{"schemas":{"MerchantDemographics.References.Api.Models.StateOptionCollection":{"type":"object","properties":{"content":{"type":"array","items":{"$ref":"#/components/schemas/MerchantDemographics.References.Api.Models.StateOption"},"description":"A collection of State Option and their respective details.","nullable":true}},"additionalProperties":false},"MerchantDemographics.References.Api.Models.StateOption":{"type":"object","properties":{"stateCode":{"type":"string","description":"The unique code for the state or province, typically represented as an abbreviation.","nullable":true},"stateName":{"type":"string","description":"The full name of the state or province.","nullable":true},"isDisplayed":{"type":"boolean","description":"Indicates whether the state or province should be displayed in the UI or a specific context."},"countryCode":{"type":"string","description":"The country code associated with this state or province, typically using ISO 3166-1 alpha-2 format.","nullable":true}},"additionalProperties":false},"Microsoft.AspNetCore.Mvc.ProblemDetails":{"type":"object","properties":{"type":{"type":"string","nullable":true},"title":{"type":"string","nullable":true},"status":{"type":"string","nullable":true},"detail":{"type":"string","nullable":true},"instance":{"type":"string","nullable":true}},"additionalProperties":{}}}}}
```

## Get company types

> Retrieve a list of company types from the database.

```json
{"openapi":"3.0.1","info":{"title":"External US Onboarding Workflow","version":"0.0.1"},"paths":{"/api/demographics/v2/References/CompanyTypes":{"get":{"tags":["ReferencesControllerV2"],"summary":"Get company types","description":"Retrieve a list of company types from the database.","parameters":[{"name":"countryCode","in":"query","description":"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\".","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns a list of company types successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MerchantDemographics.References.Api.Models.CompanyTypeCodeCollection"}}}},"401":{"description":"Unauthorized: User does not have the required role or access.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"}}}},"500":{"description":"Internal Server Error: This could be due to system errors. Please contact support for assistance"}}}}},"components":{"schemas":{"MerchantDemographics.References.Api.Models.CompanyTypeCodeCollection":{"type":"object","properties":{"content":{"type":"array","items":{"$ref":"#/components/schemas/MerchantDemographics.References.Api.Models.CompanyTypeCode"},"description":"A collection of Company Type Code and their respective details.","nullable":true}},"additionalProperties":false},"MerchantDemographics.References.Api.Models.CompanyTypeCode":{"type":"object","properties":{"id":{"type":"integer","description":"The unique identifier for the company type.","format":"int32"},"type":{"type":"string","description":"The name or type of the company, such as LLC, SP, or NP etc.","nullable":true},"legalIdentifiersRequired":{"type":"boolean","description":"Indicates whether legal identifiers (e.g., registration number, tax ID) are required for this company type."},"description":{"type":"string","description":"A brief description of the company type, explaining its characteristics or legal structure.","nullable":true},"countryCode":{"type":"string","description":"The country code associated with the company type, typically using the ISO 3166-1 alpha-2 format.","nullable":true}},"additionalProperties":false},"Microsoft.AspNetCore.Mvc.ProblemDetails":{"type":"object","properties":{"type":{"type":"string","nullable":true},"title":{"type":"string","nullable":true},"status":{"type":"string","nullable":true},"detail":{"type":"string","nullable":true},"instance":{"type":"string","nullable":true}},"additionalProperties":{}}}}}
```

## Get legal identifier types

> Retrieve a list of legal identifier types from the database.

```json
{"openapi":"3.0.1","info":{"title":"External US Onboarding Workflow","version":"0.0.1"},"paths":{"/api/demographics/v2/References/LegalIdentifierTypes":{"get":{"tags":["ReferencesControllerV2"],"summary":"Get legal identifier types","description":"Retrieve a list of legal identifier types from the database.","parameters":[{"name":"countryCode","in":"query","description":"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.","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns a list of legal identifier types successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MerchantDemographics.References.Api.Models.LegalIdentifierTypeCodeCollection"}}}},"401":{"description":"Unauthorized: User does not have the required role or access.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"}}}},"500":{"description":"Internal Server Error: This could be due to system errors. Please contact support for assistance"}}}}},"components":{"schemas":{"MerchantDemographics.References.Api.Models.LegalIdentifierTypeCodeCollection":{"type":"object","properties":{"content":{"type":"array","items":{"$ref":"#/components/schemas/MerchantDemographics.References.Api.Models.LegalIdentifierType"},"description":"A collection of legal identifier types.","nullable":true}},"additionalProperties":false},"MerchantDemographics.References.Api.Models.LegalIdentifierType":{"type":"object","properties":{"type":{"type":"string","description":"The type of legal identifier (TIN, SSN, SIRET, etc.)","nullable":true},"description":{"type":"string","description":"A description of the legal identifier type.","nullable":true},"isVatIdentifier":{"type":"boolean","description":"Indicates whether the identifier is a VAT-related identifier."},"countryCode":{"type":"string","description":"The country code associated with the legal identifier.","nullable":true}},"additionalProperties":false},"Microsoft.AspNetCore.Mvc.ProblemDetails":{"type":"object","properties":{"type":{"type":"string","nullable":true},"title":{"type":"string","nullable":true},"status":{"type":"string","nullable":true},"detail":{"type":"string","nullable":true},"instance":{"type":"string","nullable":true}},"additionalProperties":{}}}}}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.xplorpay.com/api-reference/api/merchant-onboarding/onboard-merchant/merchant-demographics/referencescontrollerv2.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
