Sign in

v5

OpenAPI 3.1.0Proprietary2026-08-011476181.4 MB
Invitations

Claim an UMA invitation

Claim an UMA invitation by associating it with an invitee UMA address.

When an invitation is successfully claimed:

  1. The invitation status changes from PENDING to CLAIMED
  2. The invitee UMA address is associated with the invitation
  3. An INVITATION_CLAIMED webhook is triggered to notify the platform that created the invitation

This endpoint allows customers to accept invitations sent to them by other UMA customers.

post/invitations/{invitationCode}/claim

Path parameters

invitationCodestring required

The code of the invitation to claim

Request body

inviteeUmastring required

The UMA address of the customer claiming the invitation

Example request

{
  "inviteeUma": "$invitee@uma.domain"
}

Response

Invitation claimed 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
    }
  }
}