Skip to content
/
Client Application Manage...

Cheqi API (v1)

Cheqi provides APIs for creating receipts and reading receipts for customers

Download OpenAPI description
api-docs.json
api-docs.yaml
Languages
Servers
Mock server
https://docs.cheqi.io/_mock/apis/api-docs
Generated server url
https://test.api.cheqi.io

Client Application Management

Endpoints for managing OAuth2 client applications, including registration, secret management, and public key configuration

Operations

Get client application public key

Request

Retrieves the public key information for a client application, including the key data, algorithm, and upload timestamp. This key is used to verify signatures from the client application.

Accessible for: Company, User

Security
cheqi_oauth
Path
clientApplicationIdstring(uuid)required

Client application ID

curl -i -X GET \
  'https://docs.cheqi.io/_mock/apis/api-docs/client-application/{clientApplicationId}/public-key' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Public key retrieved successfully

Bodyapplication/json
publicKeystring
keyAlgorithmstring
Enum"RSA_2048""RSA_4096""ECDSA_P256""ECDSA_P384""ED25519"
keyCreatedAtstring(date-time)
hasKeyboolean
Response
application/json
{
  "publicKey": "string",
  "keyAlgorithm": "RSA_2048",
  "keyCreatedAt": "2019-08-24T14:15:22Z",
  "hasKey": true
}

Upload client application public key

Request

Uploads a public key for the client application. This key is used to verify signatures from the client application when it signs receipts or other data. Can be called by company admins or using company API key authentication.

Accessible for: Company, User

Security
cheqi_oauth
Path
clientApplicationIdstring(uuid)required

Client application ID

Bodyapplication/jsonrequired
publicKeystringrequired
keyAlgorithmstringrequired
Enum"RSA_2048""RSA_4096""ECDSA_P256""ECDSA_P384""ED25519"
curl -i -X POST \
  'https://docs.cheqi.io/_mock/apis/api-docs/client-application/{clientApplicationId}/public-key' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "publicKey": "string",
    "keyAlgorithm": "RSA_2048"
  }'

Responses

Public key uploaded successfully

Credit Note Management

Endpoints for creating, managing, and retrieving credit notes (refund receipts)

Operations

Recipient Management

Endpoints for resolving and matching receipt recipients

Operations

Receipt Management

Endpoints for creating and managing purchase receipts with end-to-end encryption

Operations

Webhook Management

Endpoints for managing webhook subscriptions to receive real-time event notifications

Operations