Help center
https://api.certo.bio/v1openapi.json
Withdraw an invitation
POST
/v1/invitations/{id}/withdrawscope hiring:inviteWithdraws an open invitation. The credit comes back, unless the sponsored identity check it paid for already started.
As an MCP tool: withdraw_invitation
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
| id | uuid | Yes | The invitation. |
Response fields
- invitation
- object. The invitation, withdrawn.
- invitation.id
- uuid. The invitation.
- invitation.email
- string. The address invited.
- invitation.status
- one of open, accepted, declined, expired, withdrawn. open, accepted, declined, expired or withdrawn.
- invitation.sponsored
- boolean. The organisation pays the candidate's verification.
- invitation.position_id
- uuid or null. The position it is for.
- invitation.candidate_id
- uuid or null. The grant once accepted.
- invitation.custom_data
- object or null. Your own data on the invitation, as you sent it; null for none.
- invitation.created_at
- string. When it was sent.
- invitation.expires_at
- string or null. When it expires unanswered.
- credit_returned
- boolean. Whether its credit came back (false when the identity check it paid for had started).
- credits
- object. The credits.
- credits.balance
- integer. The balance now.
Errors
- 404 invite.not_found
- 404 invite.not_open
- 409 api.idempotency_mismatch
- 409 api.idempotency_in_progress
- 400 api.credential_in_url
- 401 api.key_invalid
- 401 api.key_expired
- 401 api.key_revoked
- 401 api.key_suspended
- 403 api.scope_missing
- 429 api.rate_limited