Tax connection

Get the tax connection

GET /i/v1/tax-connection

Who can call it: API key or signed-in user.

Example request

bash

curl https://gp.useyona.com/i/v1/tax-connection \
  -H "Authorization: Bearer sk_test_your_key_here"

Responses

Success: 200 OK. The response uses the standard response envelope; the shape of data is not yet described.

Connect to the tax authority

POST /i/v1/tax-connection

Who can call it: Signed-in user only: do this in the Yona app.

Request body

Field	Type	Required	Description
`taxId`	string	No	Deprecated. Refused (400 VAL001): the tax number is the organisation’s verified TIN; change it in the organisation profile.
`authorityIdentifiers`	object (AuthorityIdentifiers)	No
`consent`	object (Consent)	Yes

authorityIdentifiers

Field	Type	Required	Description
`businessId`	string (uuid)	No	The authority business id the tenant believes is theirs.
`serviceId`	string	No

consent

Field	Type	Required	Description
`accepted`	boolean	Yes	The tenant accepts Yona as its transmitting tax partner. One of `true`.
`textVersion`	string	Yes

Example request

bash

curl -X POST https://gp.useyona.com/i/v1/tax-connection \
  -H "Authorization: Bearer YOUR_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "consent": {
      "accepted": true,
      "textVersion": "2026-09-30"
    }
  }'

Responses

Success: 201 Created. The response uses the standard response envelope; the shape of data is not yet described.

Disconnect from the tax authority

DELETE /i/v1/tax-connection

Who can call it: Signed-in user only: do this in the Yona app.

Request body

Field	Type	Required	Description
`reason`	string	No	At most 500 characters.

Example request

bash

curl -X DELETE https://gp.useyona.com/i/v1/tax-connection \
  -H "Authorization: Bearer YOUR_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "reason": "string"
  }'

Responses

Success: 200 OK. The response uses the standard response envelope; the shape of data is not yet described.

Install the crypto key

PUT /i/v1/tax-connection/crypto-key

Who can call it: Signed-in user only: do this in the Yona app.

Request body

Field	Type	Required	Description
`envelope`	string	Yes	JWE compact (RSA-OAEP-256 + A256GCM) of the key file, encrypted in the browser to the transport key. At most 16384 characters.

Example request

bash

curl -X PUT https://gp.useyona.com/i/v1/tax-connection/crypto-key \
  -H "Authorization: Bearer YOUR_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "envelope": "string"
  }'

Responses

Success: 200 OK. The response uses the standard response envelope; the shape of data is not yet described.

Refresh the tax connection

POST /i/v1/tax-connection/refresh

Who can call it: Signed-in user only: do this in the Yona app.

Example request

bash

curl -X POST https://gp.useyona.com/i/v1/tax-connection/refresh \
  -H "Authorization: Bearer YOUR_SESSION_TOKEN"

Responses

Success: 200 OK. The response uses the standard response envelope; the shape of data is not yet described.

Get the transport key

GET /i/v1/tax-connection/transport-key

Who can call it: Signed-in user only: do this in the Yona app.

Example request

bash

curl https://gp.useyona.com/i/v1/tax-connection/transport-key \
  -H "Authorization: Bearer YOUR_SESSION_TOKEN"

Responses

Success: 200 OK. The response uses the standard response envelope; the shape of data is not yet described.