Invitations
The field to sort by (default updated_at).
The direction to sort (ASC or DESC, default DESC).
The number of invitations per page (default 20).
The current page number (default 1).
The total number of items.
If provided, returns only invitations with this state.
If provided, returns only invitations for this contact_id.
A list of invitations
Unauthorized.
Internal Server Error
The type of the invitation (OOB).
OOBThe ID of the contact.
undefinedThe handshake protocol for OOB invitations.
undefinedThe alias for the invitation.
undefinedThe mode of the invitation.
undefinedThe accept criteria for the invitation.
trueWhether the invitation is public.
falseThe role of the invitation.
undefinedThe label of the invitation.
undefinedThe status of the invitation.
undefinedThe description of the invitation.
undefinedThe purpose of the invitation (optional unique identifier - if provided, must be unique per wallet).
undefinedThe start time of the invitation's active period.
undefinedThe end time of the invitation's active period.
undefinedThe number of uses allowed for the invitation.
undefinedInvitation created successfully
https://fresh-fox-61.tun2.indiciotech.io?oob=eyJAdHlwZSI6ICJodHRwczovL2RpZGNvbW0ub3JnL291dC1vZi1iYW5kLzEuMS9pbnZpdGF0aW9uIiwgIkBpZCI6ICIzMzAyMDMyZC05MTA4LTQ4YzMtYmM3ZC1mZjZiNzU1ZDcyMmQiLCAibGFiZWwiOiAiT09CIiwgImhhbmRzaGFrZV9wcm90b2NvbHMiOiBbImh0dHBzOi8vZGlkY29tbS5vcmcvZGlkZXhjaGFuZ2UvMS4xIl0sICJzZXJ2aWNlcyI6IFsiZGlkOnNvdjo5NUxBeVFpdE5oNWtWYWF5Q0ZDOVMyIl191Bad Request
Unauthorized.
Internal Server Error
The URL of the invitation to be accepted.
undefinedExample: https://example.com/invitation?oob=abc123Invitation accepted successfully
Bad Request
Unauthorized.
Internal Server Error
The ID of the invitation.
1Invitation retrieved successfully
The retrieved invitation credential record.
Unauthorized.
Invitation not found
Internal Server Error
The ID of the invitation to update.
The workflow status of the invitation.
activeThe description of the invitation.
This is an updated invitation.The purpose of the invitation (unique identifier).
verification-demo-2025The start time of the invitation.
2023-01-01T00:00:00ZThe end time of the invitation.
2030-12-31T23:59:59ZThe number of uses allowed for the invitation.
1Invitation updated successfully
The updated invitation record.
Bad request. Invalid parameters.
Invitation record not found
Internal server error
The ID of the invitation to delete.
Invitation deleted successfully
Invitation was deleted successfully!Bad request. Invalid parameters.
Invitation record not found
Internal server error
The purpose identifier of the invitation.
demo-1Invitation retrieved successfully
The retrieved invitation credential record.
Bad request. Invalid parameters.
Unauthorized.
Invitation not found
Internal Server Error
Last updated
Was this helpful?