KintsugiKintsugi
API reference / Validate hyperline credentials

Validate hyperline credentials

POST/connections/hyperline/validate

Probe a Hyperline API key without persisting a connection, returning the companies and invoicing entities available under it for the connect picker. Returns 400 if the key is invalid.

Authorization

Api-KeystringRequired

Your secret API key. Include it with every request.

Headers

Api-Versiondate

Release date, as YYYY-MM-DD. Defaults to 2026-07-21.

Organization-Idstring

Target organization id (Organization-Id selector).

Connection-Idstring

Target connection id; resolves to its organization.

Entity-Idstring

Platform entity id; resolves to a connection's organization.

Entity-Sourcestring

Optional source to disambiguate an Entity-Id.

Body

apiKeystringRequired

Hyperline API key to probe.

Response

entitiesHyperlineValidateEntity[]

Invoicing entities available under the validated key.

companiesHyperlineValidateCompany[]

Companies available under the validated key.

environmentstring

Hyperline environment the key resolved against.

200

Successful Response

400

The request was invalid.

401

Authentication failed or was missing.

403

The credential is not permitted for this request.

404

The requested resource was not found.

422

The request failed validation.

cURL
POST /connections/hyperline/validate
-H "Api-Key: ***"
-H "Api-Version: 2026-07-21"
{
"apiKey": "********"
}
Response
{
"entities": [
{
"id": "3f6c2b1e-8a4d-4c2e-9b1f-2d7e5a6c9f10",
"name": "Acme Corp",
"companyId": "3f6c2b1e-8a4d-4c2e-9b1f-2d7e5a6c9f10",
"timezone": "America/Los_Angeles"
}
],
"companies": [
{
"id": "3f6c2b1e-8a4d-4c2e-9b1f-2d7e5a6c9f10",
"name": "Acme Corp"
}
],
"environment": "production"
}
Validate hyperline credentials (2026-07-21) | Kintsugi API Reference