PayIDs

Claim a PayID

post

Claims a PayID for a user. All PayIDs are currently free to claim.

The PayID must meet these requirements:

• Must contain only letters, numbers, hyphens, and underscores

• Must be at least 1 character long

• Must not be already claimed by another user

Users can only have one active PayID at a time. If a user claims a new PayID, their previous PayID will be automatically replaced.

Authorizations

Body

emailstring · emailRequired

Email address of the user

Example: [email protected]

twitterUsernamestringOptional

Twitter username of the user

Example: twitterhandle

payIdstringRequired

The PayID to claim. Can only contain letters, numbers, hyphens, and underscores. Must match the pattern [a-zA-Z0-9-_]+

Example: my-payid

expiresInYearsinteger · min: 1 · max: 10Required

Number of years until the PayID expires (1-10)

Example: 1

Responses

201

PayID claimed successfully

application/json

400

Invalid input

application/json

401

Unauthorized

application/json

409

PayID already taken

application/json

500

Server error

application/json

post

HTTPcURLJavaScriptPython

POST /v1/pay-ids HTTP/1.1
Host: api.reveel.id
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 100

{
  "email": "[email protected]",
  "twitterUsername": "twitterhandle",
  "payId": "my-payid",
  "expiresInYears": 1
}

{
  "success": true,
  "data": {
    "payId": "my-payid",
    "expiresAt": "2024-06-01T00:00:00.000Z",
    "transactionId": "123e4567-e89b-12d3-a456-426614174000"
  },
  "meta": {
    "message": "PayID claimed successfully"
  }
}

Search for PayIDs and retrieve user information

get

Search for PayIDs based on query parameters. The search is case-insensitive and will return partial matches.

Authorizations

Query parameters

qstring · min: 1Required

Search query (minimum 1 character)

limitinteger · max: 100Optional

Maximum number of results to return (up to 100)

Default: 10

activeOnlybooleanOptional

When true, only returns active PayIDs (not temporary reservations)

Default: true

Responses

200

Search results

application/json

400

Invalid input

application/json

401

Unauthorized

application/json

500

Server error

application/json

get

HTTPcURLJavaScriptPython

GET /v1/pay-ids/search HTTP/1.1
Host: api.reveel.id
Authorization: Bearer JWT
Accept: */*

{
  "success": true,
  "data": {
    "results": []
  },
  "meta": {
    "count": 0,
    "message": "Found 0 PayID(s)"
  }
}