GVRN OneShot API

Withdraw a request

Withdraws a request GVRN has not started, and cancels its ticket. Once it is being worked on or is closed, GVRN cancels it rather than the partner.

post/public/one-shot/requests/{requestId}/cancel

Request

  • Base URL: https://docs.gvrn.ai (the document declares no server; this is the origin it was published from)
  • URL: https://docs.gvrn.ai/public/one-shot/requests/{requestId}/cancel
  • Auth: API key in header x-gvrn-public-api-key

Path parameters

requestIdstring required

Response

Withdrawn

idstring required

The handle for reading or withdrawing it

incorporationIdstring required
companyIdstring

The company the request is about

kind'DOCUMENT' | 'COMPANY_DETAILS' | 'MEMBER_CHANGE' | 'SHARE_CAPITAL' | 'GOVERNANCE' | 'COMPLIANCE_FILING' | 'TAX' | 'ENTITY_CHANGE' | 'OTHER' required
status'OPEN' | 'IN_PROGRESS' | 'RESOLVED' | 'CANCELLED' required

Derived from the CRM ticket behind the request

subjectstring required
detailsstring
payloadobject required

Exactly what was sent, never what an operator has since edited

attachmentCountnumber required

Files stored against the request's ticket

createdAtstring required

ISO 8601

updatedAtstring required

ISO 8601

statusChangedAtstring required

When the ticket last moved; for a RESOLVED request, when it closed

cancelledAtstring

Set when the partner withdrew the request

Example response

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "incorporationId": "123e4567-e89b-12d3-a456-426614174000",
  "companyId": "123e4567-e89b-12d3-a456-426614174000",
  "subject": "Certified copy of the certificate for HSBC",
  "details": "The bank wants a certified copy dated within three months.",
  "createdAt": "2026-09-02T09:12:44.000Z",
  "updatedAt": "2026-09-02T09:12:44.000Z",
  "statusChangedAt": "2026-09-02T09:12:44.000Z"
}

Changes

No recorded changes to this operation across all 1 revision of this API.