...
In instances where there is a need to create a new broker within a specific account utilizing get the Account Token of the current user defined by the security token, by using the Thinksurance Public API V1, henceforth referred to as "the API," a dedicated endpoint facilitates this capability. This endpoint is accessible at the path /api/brokeraccount/get/settokens/{:token}. It anticipates a comprehensive payload as part of the HTTP request, encompassing the requisite broker data.
...
To create a broker via the API, it is imperative to send an HTTP POST request to the endpoint /api/brokeraccount/get/settokens/{:token}. The parameterised segment of the endpoint, denoted as "{:token}," contains to the security token retrievable by the partner during the Authentication process on the API. The rest of the HTTP request is a JSON payload of the request body.
Action name | create brokerget account token |
|---|---|
HTTP path | /api/account/brokerget/settokens/{:token}
|
HTTP method | POST |
Attributes of the HTTP request
Broker Parameters
The initial set of parameters pertains to broker data. Only specific elements within this data subset are mandatory for delivery. These required elements assist the API in providing critical information for the broker creation.
...
aToken
...
string
...
required
...
A special token used for accounts to identify itself during API calls. Provided by Thinksurance Support Team.
...
type
...
int
...
required
...
Enumeration value that defines the way for mapping broker data from the request:
1 - it requires to have broker’s ID from the partner system provided to Thinksurance System
2 - it doesn’t requires to have broker’s ID from the partner system provided to Thinksurance System
...
bExternalId
...
string
...
required
...
Broker’s ID from the partner system.
...
bGender
...
int
...
optional
...
Enumeration value that defines salutation of the broker person:
1 - Mr
2 - Ms
...
bFirstName
...
string
...
optional
...
Broker person’s first name.
...
bLastName
...
string
...
required1
...
Broker person’s last name.
...
bEmail
...
string
...
required
...
Broker person’s email address.
...
bCompany
...
string
...
required2
...
Broker company’s name.
...
bStreet
...
string
...
optional
...
Broker company’s street name.
...
bStreetNumber
...
string
...
optional
...
Broker company’s street number.
...
bZip
...
string
...
optional
...
Broker company’s postcode.
...
bCity
...
string
...
optional
...
Broker company’s city.
...
bPhone
...
string
...
optional
...
Broker company’s phone number.
...
bCompanyRegNumber
...
string
...
optional
...
Broker company’s commercial register number.
...
bRegNumber
...
string
...
optional
...
Broker company’s IHK register number.
...
1 required if bCompany is not set
2 required if bLastName is not set
No parameters are expected in the HTTP request body.
Attributes of the HTTP response
Success response | |||
|---|---|---|---|
JSON array of objects containing: | |||
statusname | string | required | A text providing more information on the succesful operationname for the requested account. |
bTokenaToken | string | required | An identifier for the new brokerrequested account. |
Failed response | |||
error | string | required | It contains a reason for the failed request. |
...
As previously stated, to execute Broker Createget account token, it is imperative to dispatch a POST HTTP request to the /api/account/brokerget/settokens/{:token} endpoint of the API. Below, instances of potential communication between the API and consumers are provided.
HTTP Request with minimal data for company | |||||
| |||||
HTTP Request with minimal data for a person | |||||
| |||||
Successful HTTP Response | |||||
| |||||
Failed HTTP Response | |||||
|