Skip to main content
POST
/
sign
Sign a GOBL document
curl --request POST \
  --url https://gobl.dev/v0/sign \
  --header 'Content-Type: application/json' \
  --data '
{
  "data": "<unknown>",
  "template": "<unknown>",
  "privatekey": {
    "kty": "EC",
    "crv": "P-256",
    "alg": "ES256",
    "use": "sig",
    "kid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "x": "<string>",
    "y": "<string>",
    "d": "<string>"
  },
  "type": "<string>",
  "envelop": true
}
'
{
  "code": 422,
  "key": "<string>",
  "message": "<string>",
  "faults": [
    {
      "properties": [
        "<string>"
      ],
      "description": "<string>"
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://gobl-correction-definitions.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

Body

application/json
​
data
any
required

GOBL document to sign.

​
template
any

Optional template to merge with the data before signing.

​
privatekey
object

ES256 private key in JWK format.

​
type
string

Document type hint.

​
envelop
boolean
default:true

Wrap in envelope (always true for signing).

Response

Signed envelope