Page Comparison

...

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

required¹

Broker person’s last name.

bEmail

string

required

Broker person’s email address.

bCompany

string

required²

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.

Explanations:

Anchor

	broker
	broker
isMissingRequiredParameters	true

¹ required if bCompany is not set
² required if bLastName is not set

Attributes of the HTTP response

...

HTTP Request with minimal data for company

Code Block

language	json

# HTTP POST
# https://app.dev.thinksurance.de/api/broker/set/{:token}
# 'Content-Type': 'application/json'
# 'Accept': 'application/json'
{
  "aToken": "some string as an identifier",
  "type": 1,
  "bExternalId": "T5",
  "bEmail": "awesome.gmbh@email.com",
  "bCompany": "Awesome GmbH"
}

HTTP Request with minimal data for a person

Code Block

language	json

# HTTP POST
# https://app.dev.thinksurance.de/api/broker/set/{:token}
# 'Content-Type': 'application/json'
# 'Accept': 'application/json'
{
  "aToken": "some string as an identifier",
  "type": 1,
  "bExternalId": "T5",
  "bEmail": "mustermann@email.com",
  "bLastName": "Mustermann"
}

Successful HTTP Response

Code Block

language	json

# HTTP 200 status code
# 'Content-Type': 'application/json'
{
  "status": "Broker Api: broker created succesfully.",
  "bToken": "some hashed string"
}

Failed HTTP Response

Code Block

language	json

# HTTP 200 status code
# 'Content-Type': 'application/json'
{
  "error": "API User is not existing or deactivated."
}

...

Versions Compared

Old Version 5

New Version Current

Key

Attributes of the HTTP response