/get_business_roles
Gets a list of valid business roles that can be used to link individuals to businesses.
The business roles that are returned in this endpoint are required in requests to endpoints /link_business_member and /unlink_business_member.
Requests
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.
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_roles HTTP/1.1
Host: sandbox.silamoney.com
authsignature: [GENERATED AUTHSIGNATURE HEX STRING HERE]
Content-Type: application/json
{
"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_roles": [
{
"uuid": "2352ec19-130d-45ba-8e0f-83a5b902e7ce",
"name": "controlling_officer",
"label": "Controlling Officer"
},
{
"uuid": "280a47ce-a70c-4015-aaeb-1865593a29e3",
"name": "beneficial_owner",
"label": "Beneficial Owner"
},
{
"uuid": "4684354c-1de3-48c8-bc3c-047a2b6185f0",
"name": "administrator",
"label": "Administrator"
}
]
}
const res = await Sila.getBusinessRoles();
// Success Response Object
console.log(res.statusCode); // 200
console.log(res.data.status);
console.log(res.data.success); // TRUE
console.log(res.data.business_roles); // Business roles list
console.log(res.data.business_roles[0].uuid);
console.log(res.data.business_roles[0].name);
console.log(res.data.business_roles[0].label);
response = BusinessInformation.getBusinessRoles(silaApp)
#### Success Response Object
{
"status": 'SUCCESS',
"status_code": 200,
"success": true,
"business_roles": [
{
"uuid": "2352ec19-130d-45ba-8e0f-83a5b902e7ce",
"name": "controlling_officer",
"label": "Controlling Officer"
},
...
]
}
ApiResponse response = api.getBusinessRoles();
GetBusinessRolesResponse parsedResponse = (GetBusinessRolesResponse) response.getData();
// Success Object Response
System.out.println(response.getStatusCode()); // 200
parsedResponse.isSuccess();
parsedResponse.getStatus();
parsedResponse.getBusinessRoles(); // List of business roles.
parsedResponse.getBusinessRoles().get(0).getUuid();
parsedResponse.getBusinessRoles().get(0).getName();
parsedResponse.getBusinessRoles().get(0).getLabel();
$response = $client->getBusinessRoles();
// Response 200
echo $response->getStatusCode(); // 200
echo $response->getData()->status;
echo $response->getData()->success; // TRUE
echo $response->getData()->business_roles; // An array of business roles (uuid, name, label)
ApiResponse<object> response = api.GetBusinessRoles();
// Success Response Object 200
Console.WriteLine(response.StatusCode); // 200
var parsedData = (BusinessRolesResponse)response.Data;
parsedData.BusinessRoles; // Business roles 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 Code | success Attribute | Description |
---|---|---|
200 | true | Successful request; business roles returned. |
400 | false | Bad request format - check validation_details for more information. |
403 | false | Auth signature is absent or derived address does not belong to app_handle. |
Updated about 2 years ago