Skip to content

Company API (v2)

Download OpenAPI description
Languages
Servers
Sandbox URL
https://api-ext-sboxmeta.partners.spotnana.com
Spotnana mock server
https://developer.spotnana.com/_mock/openapi/companyapi

Companies

APIs to onboard and manage company.

Operations

Cost Centers

APIs to create and manage company cost centers.

Operations

Offices

APIs to create and manage company offices.

Operations

Departments

APIs to create and manage departments.

Operations

Service Charge Plan

APIs to manage service charge plans.

Operations

Partner Public Keys

APIs to manage partner public keys for token exchange authentication.

Operations

Add partner public key

Request

Adds a public key for a partner organization to use for token exchange authentication. Only one active key is allowed per organization. Accessible to TMC, company, and global admins.

Security
Bearer
Path
companyIdstring(uuid)required

Organization identifier.

Example: 4974a66b-7493-4f41-908c-58ba81093947
Bodyapplication/jsonrequired
publicKeyJwkstringrequired

Public key in JWK (JSON Web Key) format. Must include a 'kid' field. Supported key types: RSA, EC.

Example: "{\"kty\":\"RSA\",\"alg\":\"RS256\",\"kid\":\"my-key-1\",\"n\":\"...\",\"e\":\"AQAB\"}"
curl -i -X POST \
  https://api-ext-sboxmeta.partners.spotnana.com/v2/companies/4974a66b-7493-4f41-908c-58ba81093947/partner-public-keys \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "publicKeyJwk": "{\"kty\":\"RSA\",\"alg\":\"RS256\",\"kid\":\"my-key-1\",\"n\":\"...\",\"e\":\"AQAB\"}"
  }'

Responses

Key created successfully.

Bodyapplication/json
idstring(uuid)

Unique identifier for the key.

orgIdstring(uuid)

Organization this key is scoped to.

kidstring

Key ID extracted from the JWK.

statusstring

Key status.

Enum"ACTIVE""REVOKED"
createdAtstring(date-time)

Timestamp when the key was created.

thumbprintstringread-only

RFC 7638 JWK thumbprint (base64url SHA-256 of canonical key material). Use this to verify the correct key was registered.

Response
application/json
{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "orgId": "25b2c2d5-a7fc-47d0-89e4-8709a1560bfa", "kid": "string", "status": "ACTIVE", "createdAt": "2019-08-24T14:15:22Z", "thumbprint": "string" }

List partner public keys

Request

Lists partner public keys for a TMC. Accessible to TMC, company, and global admins.

Security
Bearer
Path
companyIdstring(uuid)required

Organization identifier.

Example: 4974a66b-7493-4f41-908c-58ba81093947
Query
statusstring

Filter keys by status. Defaults to ACTIVE.

Enum"ACTIVE""REVOKED"
curl -i -X GET \
  'https://api-ext-sboxmeta.partners.spotnana.com/v2/companies/4974a66b-7493-4f41-908c-58ba81093947/partner-public-keys?status=ACTIVE' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Bodyapplication/json
keysArray of objects(PartnerPublicKeyInfo)

List of partner public keys.

Response
application/json
{ "keys": [ {} ] }

Revoke partner public key

Request

Revokes a partner public key identified by kid. Accessible to TMC, company, and global admins.

Security
Bearer
Path
companyIdstring(uuid)required

Organization identifier.

Example: 4974a66b-7493-4f41-908c-58ba81093947
kidstringrequired

Key ID (kid field from the JWK).

Example: my-key-1
curl -i -X DELETE \
  https://api-ext-sboxmeta.partners.spotnana.com/v2/companies/4974a66b-7493-4f41-908c-58ba81093947/partner-public-keys/my-key-1 \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Key revoked successfully.

Response
No content

Service Charge

Operations

Company Enrollment

Operations

Company Tier

Operations

Stealth Config

Operations