External API Consumer
Overview
External API Consumers are machine identities, external servers, or services that call Bridflow APIs using HTTP Basic Authentication instead of user JWT flows. Use this authentication method for server-to-server integrations where long-lived credentials are required.
- Username: UUID assigned to the External API Consumer, for example
3fa85f64-5717-4562-b3fc-2c963f66afa6. - Password: secret string generated by Bridflow when the consumer is created.
- Auth scheme: HTTP Basic Auth over TLS (HTTPS).
This section covers authentication only. Account creation, account status, transfer route discovery, and Auto Convert Routes are documented in their own sections.
Quick verification (first request)
Use the following request to verify that a consumer’s credentials are valid and to retrieve the current user information.
cURL with explicit header:
curl https://api-preview.kunga.eu/identity/current/v1 --request QUERY --header 'Content-Type: application/json' --header 'Authorization: Basic <BASE64(uuid:password)>' --data '{}'cURL with -u:
curl -u "uuid:password" https://api-preview.kunga.eu/identity/current/v1 --request QUERY --header 'Content-Type: application/json' --data '{}'The endpoint above returns the representation of the current identity, the External API Consumer, when credentials are valid.
If your HTTP client or proxy does not allow the custom QUERY method, send the same request as PATCH, or send POST/PATCH with X-HTTP-Method-Override: QUERY.