Introduction

Endpoint

Action name	get insurers
HTTP path	/api/insurers
HTTP method	POST

Attributes of the HTTP request

token	string	required	A security token provided from Authentication endpoint.

Attributes of the HTTP response

Success response
JSON array of objects containing:
id	int	required	An unique identifier of the insurer.
name	string	required	An insurer’s name.
bafin	string	required	An insurer’s BaFinId.
Failed response
error	string	required	It contains a reason for the failed request.

Examples

HTTP Request

# HTTP POST
# /api/insurers
# 'Content-Type': 'application/json'
# 'Accept': 'application/json'
{
  "token": "some long string value"
}

Successful HTTP Response

# HTTP 200 status code
# 'Content-Type': 'application/json'
[
  {
    "id": 1,
    "name": "Insurer1",
    "bafin": "id123456"
  },
  {
    "id": 2,
    "name": "Insurer2",
    "bafin": "id654321"
  }
]

Failed HTTP Response

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

Get Insurers

Introduction

Endpoint

Attributes of the HTTP request

Attributes of the HTTP response

Examples