Skip to content
forgit api docs

Verify a GPG key

POST
/user/gpg_key_verify

Authorizations

Section titled “ Authorizations ”

Request Body

Section titled “ Request Body ”
Media type application/json

VerifyGPGKeyOption options verifies user GPG key

object
armored_signature
string
key_id
required

An Signature for a GPG key token

string
Example generated 
{
  "armored_signature": "example",
  "key_id": "example"
}

Responses

Section titled “ Responses ”

201

Section titled “ 201 ”

GPGKey

Media type application/json

GPGKey a user GPG key to sign commit and tag in repository

object
can_certify
boolean
can_encrypt_comms
boolean
can_encrypt_storage
boolean
can_sign
boolean
created_at
string format: date-time
emails
Array<object>

GPGKeyEmail an email attached to a GPGKey

object
email
string
verified
boolean
expires_at
string format: date-time
id
integer format: int64
key_id
string
primary_key_id
string
public_key
string
subkeys
Array<object> recursive
verified
boolean
Example generated 
{
  "can_certify": true,
  "can_encrypt_comms": true,
  "can_encrypt_storage": true,
  "can_sign": true,
  "created_at": "2026-04-15T12:00:00Z",
  "emails": [
    {
      "email": "example",
      "verified": true
    }
  ],
  "expires_at": "2026-04-15T12:00:00Z",
  "id": 1,
  "key_id": "example",
  "primary_key_id": "example",
  "public_key": "example",
  "subkeys": [],
  "verified": true
}

401

Section titled “ 401 ”

APIUnauthorizedError is a unauthorized error response

Media type application/json
object
message
string
url
string
Example generated 
{
  "message": "example",
  "url": "example"
}

403

Section titled “ 403 ”

APIForbiddenError is a forbidden error response

Media type application/json
object
message
string
url
string
Example generated 
{
  "message": "example",
  "url": "example"
}

404

Section titled “ 404 ”

APINotFound is a not found error response

Media type application/json
object
errors
Array<string>
message
string
url
string
Example generated 
{
  "errors": [
    "example"
  ],
  "message": "example",
  "url": "example"
}

422

Section titled “ 422 ”

APIValidationError is error format response related to input validation

Media type application/json
object
message
string
url
string
Example generated 
{
  "message": "example",
  "url": "example"
}