SureTax Config API

GET LegalEntities

OVERVIEWREQUESTRESPONSETRY IT OUT

Overview

The GET LegalEntities API endpoint facilitates the process of getting a legal entity info.

OperationId: GET LegalEntities

Authorization Method(s): OAuth

Verb: GET

End Point: /api/v1/Account/LegalEntities/{entitycode}

Query Parameters

Query parameters in an API operation are key-value pairs that are included in the URL of an API request to filter or modify the data returned by the API. They come after the `?` in the URL and are often used to pass optional parameters like search terms, pagination information, sorting criteria, or filters to narrow down the data in the response.

Display String	Field Name	Field Type
Entitycode*	entitycode	string

*Mandatory parameter

GetLegalEntityResponse

OVERVIEWEXAMPLE

Overview

Represents the response containing the legal entity info.

GetLegalEntityResponse

Display Name	Field Name	Field Type
Validation Key	validationKey	string
Entity Name	entityName	string
Contact Numbers	contactNumbers	array[ContactNumbersResponse]
Entity Address	entityAddress	array[EntityAddressResponse]
Contact Persons	contactPersons	array[ContactPersonsResponse]
Fein	fein	string
Website	website	string
Notification Business Email	notificationBusinessEmail	string
Entity Description	entityDescription	string

ContactNumbersResponse

Display Name	Field Name	Field Type
Contact Number Type	contactNumberType	string
Contact Phone Number	contactPhoneNumber	string

EntityAddressResponse

Display Name	Field Name	Field Type
Address1	address1	string
Address2	address2	string
City	city	string
State	state	string
Country	country	string
Zipcode	zipcode	string
Plus4	plus4	string

ContactPersonsResponse

Display Name	Field Name	Field Type
Person Type	personType	string
Person Name	personName	string
Email Address	emailAddress	string

Example Response

The following is an example response you can expect for this operation

{
  "validationKey": "7dd28433-3c1b-4a44-a723-89aa9ead9a9b",
  "entityName": "003258888",
  "contactNumbers": [
    {
      "contactNumberType": "Office",
      "contactPhonenumber": "1238123234"
    }
  ],
  "entityAddress": {
    "address1": "1567 Street ct",
    "address2": "",
    "city": "Frisco",
    "state": "TX",
    "country": "US",
    "zipcode": "11111",
    "plus4": "1234"
  },
  "contactPersons": [
    {
      "personType": "PRIMARY",
      "personName": "testname",
      "emailAddress": "example@example.com"
    }
  ],
  "fein": "1234567890",
  "website": "www.example.com",
  "notificationBusinessEmail": "business@wk.com",
  "entityDescription": "Description"
}

Response Codes

Response codes in an API indicate the outcome of a request. They are three-digit numbers returned by the server to help the client understand if the request was successful, encountered an error, or needs further action. This operation has the following possible responses.

code	description
200	The API Response contains the information of the legal entity.
204	204 No Content If no records are found for the provided request, the API will respond with a No Content status.
400	Bad request. Invalid parameters or missing required information.
401	Unauthorized access. The request requires user authentication.
500	Internal server error. An error occurred while processing the request.

To execute a web service call for API Key Enabled APIs, Select an environment and enter the client number and validation api key corresponding to that environment.

Select Environment:End Point:

/api/v1/Account/LegalEntities/{entitycode}

Add Request Headers: