Skip to main content
POST
/
api
/
services
/
account-information
Create session
curl --request POST \
  --url https://api.eu1.hellgate.cloud/api/services/account-information \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "market": "DE",
  "redirect_urls": {
    "success": "https://shop.example/verify/success",
    "failure": "https://shop.example/verify/failure"
  },
  "account_identifier": {
    "iban": "DE89370400440532013000"
  }
}
'
{
  "id": "3f7c1e9a-2b4d-4c6e-8a1f-9d0b2c3e4f56"
}

Authorizations

Authorization
string
header
required

An Account Information–scoped OAuth2 access token obtained from the platform Authentication API. Send it as a bearer token on every request.

Body

application/json
market
string
required

ISO 3166-1 alpha-2 country code of the market the shopper banks in. Determines bank coverage for the check.

Example:

"DE"

redirect_urls
object
required

Where the shopper's browser lands after the bank step.

account_identifier
object

Optional. If you already know the shopper's account, supply it to pre-bind the bank and let the shopper skip ahead. Keyed by identifier type. Treated as personal data under the same retention controls as the rest of the attempt.

Response

The session was created.

id
string<uuid>
required

The session ID — a short-lived, client-shareable secret. Initialize the Web SDK with it.

Example:

"3f7c1e9a-2b4d-4c6e-8a1f-9d0b2c3e4f56"