API Documentation

/get_business_types

Gets a list of valid business types that can be registered.

Suggest Edits

A business type must be included and specified by the name or uuid value when creating a new business entity via the /register endpoint. These are the valid business types that can be registered, along with whether beneficial owners need to be linked and certified:

Business TypeBeneficial Owner Certification Required?
Sole Proprietorshipexempt
Trustexempt
Unincorporated Associationexempt
Public Corporationexempt
Partnershiprequired for > 25% ownership
Non-Profitrequired for > 25% ownership
LPrequired for > 25% ownership
LLPrequired for > 25% ownership
LLCrequired for > 25% ownership
Corporationrequired for > 25% ownership

Requests

Authorization / Authentication

Apps using Access Token Authorization

Use a valid access token in a Authorization: Bearer request header.

See Authenticating with an Access Token for more details.

Apps using ECDSA Authentication

This endpoint requires an authsignature header, but no usersignature header.
No header.user_handle field is required or validated in the header object in the request body.

See the section on ECDSA Authentication for more detail about ECDSA signature generation.

Note - We recently renamed the field auth_handle to app_handle. For backward compatibility, auth_handle is still valid but has been removed from our documentation.

POST /0.2/get_business_types HTTP/1.1
sandbox.silamoney.com
Content-Type: application/json
// if using OAuth2
Authorization: Bearer [GENERATED JWT TOKEN HERE]
// if using ECDSA
authsignature: [GENERATED AUTHSIGNATURE HEX STRING HERE]

{
  "header": {
    "created": 1234567890,
    "app_handle": "your_app_handle.silamoney.eth",
    "reference": "<your unique id>"
  }
}

***

HTTP/1.1 200 OK

{
    "success": true,
    "status": "SUCCESS",
    "response_time_ms": "171",
    "reference": "<your unique id>",
    "business_types": [
        {
            "uuid": "4819b5f8-4cab-4366-95ec-df7a36c5c140",
            "name": "corporation",
            "label": "Corporation",
          	"requires_certification": true
        },
        {
            "uuid": "1f59d93e-c1f0-4d7d-8665-a4541effdc1a",
            "name": "llc",
            "label": "LLC",
          	"requires_certification": true
        },
        {
            "uuid": "81f5340d-f405-4363-aca0-85de33b7c0ce",
            "name": "llp",
            "label": "LLP",
          	"requires_certification": true
        },
        {
            "uuid": "d7d983a3-d936-470d-a759-4596c1381e8f",
            "name": "lp",
            "label": "LP",
          	"requires_certification": true
        },
        {
            "uuid": "8944e74f-6e11-4b82-8534-f3b89a332ab2",
            "name": "non_profit",
            "label": "Non-Profit",
          	"requires_certification": true
        },
        {
            "uuid": "652c7e6d-db05-4804-807e-8f388a3c0840",
            "name": "partnership",
            "label": "Partnership",
          	"requires_certification": true
        },
        {
            "uuid": "92a57cc4-3c84-4f16-8e81-5b7523e7412e",
            "name": "public_corporation",
            "label": "Public Corporation",
          	"requires_certification": false
        },
        {
            "uuid": "ab481bed-e25f-41bb-b451-d0f524fe344e",
            "name": "sole_proprietorship",
            "label": "Sole Proprietorship",
          	"requires_certification": false
        },
        {
            "uuid": "3dc8c4cc-cf77-4ee3-ab33-ec9973b3104e",
            "name": "trust",
            "label": "Trust",
          	"requires_certification": false
        },
        {
            "uuid": "74ac27b4-7d7a-4368-b36b-454a09dc92a1",
            "name": "unincorporated_association",
            "label": "Unincorporated Association",
          	"requires_certification": false
        }
    ]
}

const res = await Sila.getBusinessTypes();

// Success Response Object
console.log(res.statusCode); // 200
console.log(res.data.success); // TRUE
console.log(res.data.status);
console.log(res.data.business_types); // Business types list
console.log(res.data.business_types[0].uuid);
console.log(res.data.business_types[0].name);
console.log(res.data.business_types[0].label);
console.log(res.data.business_types[0].requires_certification);

response = BusinessInformation.getBusinessTypes(silaApp)

### Success Response Object
{
    "status": 'SUCCESS',
    "status_code": 200,
    "success": true,
    "business_types": [
        {
            "uuid": "4819b5f8-4cab-4366-95ec-df7a36c5c140",
            "name": "corporation",
            "label": "Corporation"
        },
        ...
    ]
}

ApiResponse response = api.getBusinessTypes();
GetBusinessTypesResponse parsedResponse = (GetBusinessTypesResponse) response.getData();

// Success Object Response
System.out.println(response.getStatusCode()); // 200
parsedResponse.isSuccess();
parsedResponse.getStatus();
parsedResponse.getBusinessTypes(); // List of business types.
parsedResponse.getBusinessTypes().get(0).getUuid();
parsedResponse.getBusinessTypes().get(0).getName();
parsedResponse.getBusinessTypes().get(0).getLabel();
parsedResponse.getBusinessTypes().get(0).isRequiresCertification();

$response = $client->getBusinessTypes();

// Response 200
echo $response->getStatusCode(); // 200
echo $response->getData()->status;
echo $response->getData()->success; // TRUE
echo $response->getData()->business_types; // An array of business types (uuid, name, label)

ApiResponse<object> response = api.GetBusinessTypes();

// Success Response Object 200

Console.WriteLine(response.StatusCode); // 200
var parsedData = (BusinessTypesResponse)response.Data;
parsedData.BusinessTypes; // Business types list
parsedData.Success; // Success

Responses

The status attribute is a JSON key sent in the response body.

📘

Using the UUIDs

Please be aware that the UUID values for business types will differ between the sandbox and production environments. If you anticipate using a hard-coded or cached list of UUIDs, ensure that you maintain a separate list for each environment.

Status Codesuccess AttributeDescription
200trueSuccessful request; business types returned.
400falseBad request format - check validation_details for more information.
403falseAuth signature is absent or derived address does not belong to app_handle.

Updated about 1 year ago