Client/LFE

Summary

In summary the above information and documentation is to provide the understanding the Client/LFE API and its associated information

Description: This API will return a list of LFEs for a parent account.

API Name: /Client/LFE

HTTP Method: Get

HTTP Status Codes:

HTTP Status Codes Description
1 200 OK
2 204 No Content
3 400 Bad Request 
/// OK EXAMPLE [200]
{
  "Data": {
      "Result": [{
              "LFEId": "0000022222",
              "LFEName": "ABC",
              "Status": "Active"
              }
      ]
  },
  "Status": "OK",
  "Errors": null
 }

API Request

Request Parameter DataType Validations Mandatory Description
1 Access Token Header
2 UserId No Header

API GET Response

Response Field DataType Description
1 LFEId string (25) LFE Identifier
2 LFEName string (100) Legal Filing Entities Name
3 Status string Active or Inactive

Case 1. Get Company’ children list for specific LFEId

1. Consider you want to get the list of children companies for a specific parent company.

2. User requires a token that should be generated with the combination of “Account number”, “Service User Id” and “Service Principal Id” (the Service User Id should be authorized to see the information for the desired company).

3. To execute the API request, user requires bearer token as well as an authorization. If user do not hold the bearer token, then the user does not have permission to execute the API request.

4. It is not required an LFEId, UserId, body or to add any parameter since all the required information is contained in the token

5. When user execute the valid API request, he gets the response in the following format:

/// OK EXAMPLE [200]
{
  "Data": {
      "Result": [{
              "LFEId": "LFEId",
              "LFEName": "Child company name",
              "Status": "Active/Inactive"
              }
      ]
  },
  "Status": "OK",
  "Errors": null
 }

Case 2. Consulting the list company’s children of a company that is not having children’s companies:

1.Consider you want to get the list of children companies for a specific parent company that is not having children’s companies.

2.User requires a token that should be generated with the combination of “Account number”, “Service User Id” and “Service Principal Id” (the Service User Id should be authorized to see the information for the desired company).

3.To execute the API request, user requires bearer token as well as an authorization. If user do not

hold the bearer token, then the user does not have permission to execute the API request.

4.It is not required an LFEId, UserId, body or to add any parameter since all the required information is contained in the token

5.When user execute the valid API request, he gets the response in the following format:

/// No Content example [204]
/// For this case, only the http status code 204 will be returned.

Case 3. Consulting the list company’s children of a company with a ServiceUserId that is not authorized to get the list

1.Consider you want to get the list of children companies for a specific parent company that is not having children’s companies.

2.User requires a token that should be generated with the combination of “Account number”, “Service User Id” and “Service Principal Id” (the Service User Id should not be authorized to see the information for the desired company).

3.To execute the API request, user requires bearer token as well as an authorization. If user do not hold the bearer token, then the user does not have permission to execute the API request.

4.It is not required an LFEId, UserId, body or to add any parameter since all the required information is contained in the token

5.When user execute the valid API request, he gets the response in the following format:

/// Unauthorized example [401]
/// For this case, only the http status code 401 will be returned.