KintsugiKintsugi
API reference / Get a vertex o-series connection's install credentials

Get a vertex o-series connection's install credentials

GET/connections/vertex-o-series/{conn_id}/credentials

Return the Vertex credentials to enter into the external system's Vertex connector (Shopify / NetSuite / Zuora) to complete installation. Allocates a partition from the shared pool on the first call for this connection. Works for a connection of any source that uses Vertex as its tax engine, not only a Vertex O-Series connector connection. Served only from this route; never returned on the generic connection read. Returns 404 if the connection does not exist or belongs to an organization your credential cannot access. Returns 503 if no partition is currently available. A multi-org credential must send an Organization-Id, Connection-Id or Entity-Id selector, or gets a 400.

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.

Path parameters

conn_idstringRequired

The unique identifier of the connection.

Response

customerClientIdstringRequired

Vertex customer client id.

customerClientSecretstringRequired

Vertex customer client secret.

owningPartyCodestringRequired

Vertex Company Code, always {organizationId}-{connId}.

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.

503

A service this request depends on was unavailable. Retry the request.

cURL
GET /connections/vertex-o-series/{conn_id}/credentials
-H "Api-Key: ***"
-H "Api-Version: 2026-07-21"
Example request
https://api.trykintsugi.com/connections/vertex-o-series/{conn_id}/credentials
Response
{
"customerClientId": "3f6c2b1e-8a4d-4c2e-9b1f-2d7e5a6c9f10",
"customerClientSecret": "********",
"owningPartyCode": "owning party code"
}
Get a vertex o-series connection's install credentials (2026-07-21) | Kintsugi API Reference