Accounts16

Backups3

Compliance24

Deposits3

Domains2

Endpoints2

Event Distribution Service9

Events1

Exports2

Gas station19

Genesis1

Intents7

Internal transfers3

Ledgers6

Omnibus4

Policies2

Requests3

Sweep thresholds2

SystemProperties1

SystemSigning1

Tenants6

Tickers2

Transactions7

TrustedPublicKeys3

User invitations8

Users4

Vaults4

Withdrawals1

User invitations

POST /v1/domains/{domainId}/users/invitations

Create a user invitation

Request

Base URL
https://docs.ripple.com (the document declares no server; this is the origin it was published from)
Auth
HTTP bearer
TypeScript
https://skmtc.dev/ripple/apis/ripple-custody-api/docs/v1/domains/:domainId/users/invitations/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

domainIdstring uuid required

Request body

numberSecondsOfValidityinteger required

Response

OK

idstring uuid required

codestring required

status'Pending' | 'DeviceRegistered' | 'Expired' | 'Cancelled' | 'Completed' required

validUntilstring date-time required

Changes

No recorded changes to this operation across all 3 revisions of this API.