GET /v1/health

A status check that also tells SignatureAPI which accounts your worker accepts. SignatureAPI calls it during the connection checks: when an account connects or replaces your worker, and when it selects Run Checks. It never calls it while signing.

Request

GET {worker URL}/v1/health

No token, no body and no authentication. Don’t redirect it.

Response

Answer 200 within 5 seconds:

{
    "status": "ok",
    "connection_tokens": [
        "swpct_xulVJ9y9r1RWzRVwMZSzC4AMxZPCvI7W",
        "swpct_mYpxjUwvQpx33z6AT0Os67xaW8ZaLQkg"
    ]
}

Field	Description
status	ok, or degraded when the worker works with reduced capacity. It should reflect whether your worker can reach its provider.
connection_tokens	The connection tokens of the accounts allowed to use this worker. List one entry per account and mode.

You may add other fields. SignatureAPI ignores them.

Connection tokens

Each SignatureAPI account has one connection token per mode. The account owner copies it from Settings › Developers › Qualified Signatures and gives it to you. Add it to your worker’s configuration so that:

• GET /v1/health lists it in connection_tokens. The Connection token check fails for any account whose token isn’t listed, and a connect or replace saves nothing.
• Every authenticated request whose token claim connection_token isn’t on the list gets 401. See Verify a request.

A worker that serves one account in test and live mode lists two tokens. A worker that serves several accounts lists each of them. To stop serving an account, remove its token from both places.