Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

To add a new agency number via the API, it is necessary to send an HTTP POST request to the endpoint /api/broker/set/anums/{:token}. The parameterised segment of the endpoint, denoted as "{:token}," contains 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 add agency number for broker

HTTP path

/api/broker/set/anums/{:token}

HTTP method

POST

...

brokerAgencyName

bToken

string

required

A special token used for broker to identify itself during API calls. Provided by Thinksurance Support Team.

agencyNumbersagencyNumberSets

array

required

An array that holds information on all agency numbers that should be added. Each item of the array is represented by Agency Number Holder Scheme bellow.

Agency Number Holder Scheme

Anchor
holder
holder

baFinId

string

optional1

An insurer’s BaFin registration number.

insurerId

string

optional1

An insurer’s unique identifier number.

supervisingAuthorityId

string

optional1

An insurer’s BaFin ID.

e2e

array

optional2

An array that holds information on all agency numbers that should be added for one insurer, that should be used with deals made by calculation. Each item of the array is represented by Agency Number Scheme bellow.

db

array

optional2

An array that holds information on all agency numbers that should be added for one insurer, that should be used with deals made in tendering process. Each item of the array is represented by Agency Number Scheme bellow.

Agency Number Scheme

Anchor
agency
agency

brokerAgencyNumberagencyNumber

string

required

The actual agency number.

brokerAgencyEmailmatchCode

string

optional

Broker’s contact email.

externalInsurerId

string

optional

externalUniqueId

string

optional

Broker’s contact name.

brokerAgencyPhonedefaultForTenders

bool

required

defaultForCalculations

bool

required

collectionType

string

required

internalComment

string

optionalBroker’s contact phone.

active

bool

required

Explanations:

Anchor
explanations
explanations

1 one parameter out of baFinId, insurerId and supervisingAuthorityId is required
2 one parameter out of db and e2e is required

...