Invitations

Get an UMA invitation by code

Retrieve details about an UMA invitation by its invitation code.

get/invitations/{invitationCode}

Path parameters

invitationCodestring required

The code of the invitation to get

Response

Invitation retrieved successfully

codestring required

The unique code of the invitation

createdAtstring date-time required

When the invitation was created

claimedAtstring date-time

When the invitation was claimed if it has been claimed

urlstring required

The URL where this invitation can be claimed.

expiresAtstring date-time

When the invitation expires (if at all)

inviterUmastring required

The UMA address of the inviter

inviteeUmastring

The UMA address of the invitee

status'PENDING' | 'CLAIMED' | 'EXPIRED' | 'CANCELLED' required

The status of the invitation

firstNamestring

The inviter's first name. Will be displayed when the recipient clicks the invite link

Example response

{
  "code": "019542f5",
  "createdAt": "2025-09-01T14:30:00Z",
  "claimedAt": "2025-09-01T14:30:00Z",
  "url": "https://uma.me/i/019542f5",
  "expiresAt": "2025-09-01T14:30:00Z",
  "inviterUma": "$inviter@uma.domain",
  "inviteeUma": "$invitee@uma.domain",
  "status": "PENDING",
  "firstName": "Jane",
  "amountToSend": {
    "amount": 12550,
    "currency": {
      "code": "USD",
      "name": "United States Dollar",
      "symbol": "$",
      "decimals": 2
    }
  }
}

Changes

Changed in 7 of the 33 revisions of this API.512445

May 28, 2026d0bce562bffd6See the full diff
- ●
  added the new REQUEST_ID_MISSING enum value to the code response property for the response status 401
  response-property-enum-value-added
- ●
  added the new UMA_NOT_FOUND enum value to the code response property for the response status 404
  response-property-enum-value-added
- ●
  added the new WALLET_SIGNATURE_BODY_MISMATCH enum value to the code response property for the response status 401
  response-property-enum-value-added
- ●
  added the new WALLET_SIGNATURE_INVALID enum value to the code response property for the response status 401
  response-property-enum-value-added
- ●
  added the new WALLET_SIGNATURE_MALFORMED enum value to the code response property for the response status 401
  response-property-enum-value-added
- ●
  added the new WALLET_SIGNATURE_MISSING enum value to the code response property for the response status 401
  response-property-enum-value-added
This revision also has 6 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Mar 3, 2026efe0d983985f315See the full diff
- ▲
  the response's body type/format changed from / to object/ for status 401
  response-body-type-changed
- ▲
  the response's body type/format changed from / to object/ for status 404
  response-body-type-changed
- ▲
  the response's body type/format changed from / to object/ for status 500
  response-body-type-changed
- ○
  removed Error401_UNAUTHORIZED Error401_INVALID_SIGNATURE from the response body oneOf list for the response status 401
  response-body-one-of-removed
- ○
  removed Error404_TRANSACTION_NOT_FOUND Error404_INVITATION_NOT_FOUND Error404_USER_NOT_FOUND Error404_QUOTE_NOT_FOUND Error404_LOOKUP_REQUEST_NOT_FOUND Error404_TOKEN_NOT_FOUND Error404_BULK_UPLOAD_JOB_NOT_FOUND Error404_REFERENCE_NOT_FOUND from the response body oneOf list for the response status 404
  response-body-one-of-removed
- ○
  removed Error500_GRID_SWITCH_ERROR Error500_INTERNAL_ERROR from the response body oneOf list for the response status 500
  response-body-one-of-removed
- ○
  added the optional property details to the response with the 401 status
  response-optional-property-added
- ○
  added the optional property details to the response with the 404 status
  response-optional-property-added
- ○
  added the optional property details to the response with the 500 status
  response-optional-property-added
- ○
  added the required property code to the response with the 401 status
  response-required-property-added
- ○
  added the required property code to the response with the 404 status
  response-required-property-added
- ○
  added the required property code to the response with the 500 status
  response-required-property-added
- ○
  added the required property message to the response with the 401 status
  response-required-property-added
- ○
  added the required property message to the response with the 404 status
  response-required-property-added
- ○
  added the required property message to the response with the 500 status
  response-required-property-added
- ○
  added the required property status to the response with the 401 status
  response-required-property-added
- ○
  added the required property status to the response with the 404 status
  response-required-property-added
- ○
  added the required property status to the response with the 500 status
  response-required-property-added
This revision also has 51 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Feb 25, 2026c62cf646aaeb153See the full diff
- ▲
  added Error401_UNAUTHORIZED Error401_INVALID_SIGNATURE to the response body oneOf list for the response status 401
  response-body-one-of-added
- ▲
  added Error404_TRANSACTION_NOT_FOUND Error404_INVITATION_NOT_FOUND Error404_USER_NOT_FOUND Error404_QUOTE_NOT_FOUND Error404_LOOKUP_REQUEST_NOT_FOUND Error404_TOKEN_NOT_FOUND Error404_BULK_UPLOAD_JOB_NOT_FOUND Error404_REFERENCE_NOT_FOUND to the response body oneOf list for the response status 404
  response-body-one-of-added
- ▲
  added Error500_GRID_SWITCH_ERROR Error500_INTERNAL_ERROR to the response body oneOf list for the response status 500
  response-body-one-of-added
- ▲
  the response's body type/format changed from object/ to / for status 401
  response-body-type-changed
- ▲
  the response's body type/format changed from object/ to / for status 404
  response-body-type-changed
- ▲
  the response's body type/format changed from object/ to / for status 500
  response-body-type-changed
- ▲
  removed the required property code from the response with the 401 status
  response-required-property-removed
- ▲
  removed the required property code from the response with the 404 status
  response-required-property-removed
- ▲
  removed the required property code from the response with the 500 status
  response-required-property-removed
- ▲
  removed the required property message from the response with the 401 status
  response-required-property-removed
- ▲
  removed the required property message from the response with the 404 status
  response-required-property-removed
- ▲
  removed the required property message from the response with the 500 status
  response-required-property-removed
- ▲
  removed the required property status from the response with the 401 status
  response-required-property-removed
- ▲
  removed the required property status from the response with the 404 status
  response-required-property-removed
- ▲
  removed the required property status from the response with the 500 status
  response-required-property-removed
- ●
  removed the optional property details from the response with the 401 status
  response-optional-property-removed
- ●
  removed the optional property details from the response with the 404 status
  response-optional-property-removed
- ●
  removed the optional property details from the response with the 500 status
  response-optional-property-removed
This revision also has 24 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Feb 19, 202655dc3fc30633315See the full diff
- ▲
  the response's body type/format changed from / to object/ for status 401
  response-body-type-changed
- ▲
  the response's body type/format changed from / to object/ for status 404
  response-body-type-changed
- ▲
  the response's body type/format changed from / to object/ for status 500
  response-body-type-changed
- ○
  removed Error401_UNAUTHORIZED Error401_INVALID_SIGNATURE from the response body oneOf list for the response status 401
  response-body-one-of-removed
- ○
  removed Error404_TRANSACTION_NOT_FOUND Error404_INVITATION_NOT_FOUND Error404_USER_NOT_FOUND Error404_QUOTE_NOT_FOUND Error404_LOOKUP_REQUEST_NOT_FOUND Error404_TOKEN_NOT_FOUND Error404_BULK_UPLOAD_JOB_NOT_FOUND Error404_REFERENCE_NOT_FOUND from the response body oneOf list for the response status 404
  response-body-one-of-removed
- ○
  removed Error500_GRID_SWITCH_ERROR Error500_INTERNAL_ERROR from the response body oneOf list for the response status 500
  response-body-one-of-removed
- ○
  added the optional property details to the response with the 401 status
  response-optional-property-added
- ○
  added the optional property details to the response with the 404 status
  response-optional-property-added
- ○
  added the optional property details to the response with the 500 status
  response-optional-property-added
- ○
  added the required property code to the response with the 401 status
  response-required-property-added
- ○
  added the required property code to the response with the 404 status
  response-required-property-added
- ○
  added the required property code to the response with the 500 status
  response-required-property-added
- ○
  added the required property message to the response with the 401 status
  response-required-property-added
- ○
  added the required property message to the response with the 404 status
  response-required-property-added
- ○
  added the required property message to the response with the 500 status
  response-required-property-added
- ○
  added the required property status to the response with the 401 status
  response-required-property-added
- ○
  added the required property status to the response with the 404 status
  response-required-property-added
- ○
  added the required property status to the response with the 500 status
  response-required-property-added
This revision also has 51 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Feb 13, 2026ecd31fe01b4e153See the full diff
- ▲
  added Error401_UNAUTHORIZED Error401_INVALID_SIGNATURE to the response body oneOf list for the response status 401
  response-body-one-of-added
- ▲
  added Error404_TRANSACTION_NOT_FOUND Error404_INVITATION_NOT_FOUND Error404_USER_NOT_FOUND Error404_QUOTE_NOT_FOUND Error404_LOOKUP_REQUEST_NOT_FOUND Error404_TOKEN_NOT_FOUND Error404_BULK_UPLOAD_JOB_NOT_FOUND Error404_REFERENCE_NOT_FOUND to the response body oneOf list for the response status 404
  response-body-one-of-added
- ▲
  added Error500_GRID_SWITCH_ERROR Error500_INTERNAL_ERROR to the response body oneOf list for the response status 500
  response-body-one-of-added
- ▲
  the response's body type/format changed from object/ to / for status 401
  response-body-type-changed
- ▲
  the response's body type/format changed from object/ to / for status 404
  response-body-type-changed
- ▲
  the response's body type/format changed from object/ to / for status 500
  response-body-type-changed
- ▲
  removed the required property code from the response with the 401 status
  response-required-property-removed
- ▲
  removed the required property code from the response with the 404 status
  response-required-property-removed
- ▲
  removed the required property code from the response with the 500 status
  response-required-property-removed
- ▲
  removed the required property message from the response with the 401 status
  response-required-property-removed
- ▲
  removed the required property message from the response with the 404 status
  response-required-property-removed
- ▲
  removed the required property message from the response with the 500 status
  response-required-property-removed
- ▲
  removed the required property status from the response with the 401 status
  response-required-property-removed
- ▲
  removed the required property status from the response with the 404 status
  response-required-property-removed
- ▲
  removed the required property status from the response with the 500 status
  response-required-property-removed
- ●
  removed the optional property details from the response with the 401 status
  response-optional-property-removed
- ●
  removed the optional property details from the response with the 404 status
  response-optional-property-removed
- ●
  removed the optional property details from the response with the 500 status
  response-optional-property-removed
This revision also has 13 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Feb 13, 20262055da1ed488315See the full diff
- ▲
  the response's body type/format changed from / to object/ for status 401
  response-body-type-changed
- ▲
  the response's body type/format changed from / to object/ for status 404
  response-body-type-changed
- ▲
  the response's body type/format changed from / to object/ for status 500
  response-body-type-changed
- ○
  removed Error401_UNAUTHORIZED Error401_INVALID_SIGNATURE from the response body oneOf list for the response status 401
  response-body-one-of-removed
- ○
  removed Error404_TRANSACTION_NOT_FOUND Error404_INVITATION_NOT_FOUND Error404_USER_NOT_FOUND Error404_QUOTE_NOT_FOUND Error404_LOOKUP_REQUEST_NOT_FOUND Error404_TOKEN_NOT_FOUND Error404_BULK_UPLOAD_JOB_NOT_FOUND Error404_REFERENCE_NOT_FOUND from the response body oneOf list for the response status 404
  response-body-one-of-removed
- ○
  removed Error500_GRID_SWITCH_ERROR Error500_INTERNAL_ERROR from the response body oneOf list for the response status 500
  response-body-one-of-removed
- ○
  added the optional property details to the response with the 401 status
  response-optional-property-added
- ○
  added the optional property details to the response with the 404 status
  response-optional-property-added
- ○
  added the optional property details to the response with the 500 status
  response-optional-property-added
- ○
  added the required property code to the response with the 401 status
  response-required-property-added
- ○
  added the required property code to the response with the 404 status
  response-required-property-added
- ○
  added the required property code to the response with the 500 status
  response-required-property-added
- ○
  added the required property message to the response with the 401 status
  response-required-property-added
- ○
  added the required property message to the response with the 404 status
  response-required-property-added
- ○
  added the required property message to the response with the 500 status
  response-required-property-added
- ○
  added the required property status to the response with the 401 status
  response-required-property-added
- ○
  added the required property status to the response with the 404 status
  response-required-property-added
- ○
  added the required property status to the response with the 500 status
  response-required-property-added
This revision also has 51 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Feb 5, 202642f104b108681212See the full diff
- ▲
  the status response property const value 401 was removed for the status 401
  response-property-const-removed
- ▲
  the status response property const value 401 was removed for the status 401
  response-property-const-removed
- ▲
  the status response property const value 404 was removed for the status 404
  response-property-const-removed
- ▲
  the status response property const value 404 was removed for the status 404
  response-property-const-removed
- ▲
  the status response property const value 404 was removed for the status 404
  response-property-const-removed
- ▲
  the status response property const value 404 was removed for the status 404
  response-property-const-removed
- ▲
  the status response property const value 404 was removed for the status 404
  response-property-const-removed
- ▲
  the status response property const value 404 was removed for the status 404
  response-property-const-removed
- ▲
  the status response property const value 404 was removed for the status 404
  response-property-const-removed
- ▲
  the status response property const value 404 was removed for the status 404
  response-property-const-removed
- ▲
  the status response property const value 500 was removed for the status 500
  response-property-const-removed
- ▲
  the status response property const value 500 was removed for the status 500
  response-property-const-removed
- ●
  added the new 401.00 enum value to the oneOf[Error401_INVALID_SIGNATURE]/status response property for the response status 401
  response-property-enum-value-added
- ●
  added the new 401.00 enum value to the oneOf[Error401_UNAUTHORIZED]/status response property for the response status 401
  response-property-enum-value-added
- ●
  added the new 404.00 enum value to the oneOf[Error404_BULK_UPLOAD_JOB_NOT_FOUND]/status response property for the response status 404
  response-property-enum-value-added
- ●
  added the new 404.00 enum value to the oneOf[Error404_INVITATION_NOT_FOUND]/status response property for the response status 404
  response-property-enum-value-added
- ●
  added the new 404.00 enum value to the oneOf[Error404_LOOKUP_REQUEST_NOT_FOUND]/status response property for the response status 404
  response-property-enum-value-added
- ●
  added the new 404.00 enum value to the oneOf[Error404_QUOTE_NOT_FOUND]/status response property for the response status 404
  response-property-enum-value-added
- ●
  added the new 404.00 enum value to the oneOf[Error404_REFERENCE_NOT_FOUND]/status response property for the response status 404
  response-property-enum-value-added
- ●
  added the new 404.00 enum value to the oneOf[Error404_TOKEN_NOT_FOUND]/status response property for the response status 404
  response-property-enum-value-added
- ●
  added the new 404.00 enum value to the oneOf[Error404_TRANSACTION_NOT_FOUND]/status response property for the response status 404
  response-property-enum-value-added
- ●
  added the new 404.00 enum value to the oneOf[Error404_USER_NOT_FOUND]/status response property for the response status 404
  response-property-enum-value-added
- ●
  added the new 500.00 enum value to the oneOf[Error500_GRID_SWITCH_ERROR]/status response property for the response status 500
  response-property-enum-value-added
- ●
  added the new 500.00 enum value to the oneOf[Error500_INTERNAL_ERROR]/status response property for the response status 500
  response-property-enum-value-added
This revision also has 15 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history