HomePay(ID) Dashboard

Users

Create a new user

post

Creates a new user and associates them with the authenticated partner. If a user with the provided email already exists but is not associated with the partner, the existing user will be associated with the partner instead of creating a new user.

Authorizations
Body
emailstring · emailRequired

User's email address (required)

Example: [email protected]
twitterUsernamestringOptional

User's twitter username (optional)

Example: twitter_handle
walletAddressstringOptional

User's blockchain wallet address (optional)

Example: 0x1a2b3c4d5e6f7a8b9c0d1e2f3a4b5c6d7e8f9a0b
Responses
201
User created or associated successfully
application/json
post
POST /v1/users HTTP/1.1
Host: api.reveel.id
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 124

{
  "email": "[email protected]",
  "twitterUsername": "twitter_handle",
  "walletAddress": "0x1a2b3c4d5e6f7a8b9c0d1e2f3a4b5c6d7e8f9a0b"
}
{
  "success": true,
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "email": "[email protected]",
    "twitterUsername": "twitter_handle",
    "walletAddress": "0x1a2b3c4d5e6f7a8b9c0d1e2f3a4b5c6d7e8f9a0b",
    "createdAt": "2023-01-15T12:00:00.000Z"
  },
  "meta": {}
}

Get a user by ID

get

Retrieves a specific user by their ID (user must be associated with the authenticated partner)

Authorizations
Path parameters
idstring · uuidRequired

ID of the user to operate on

Responses
200
User retrieved successfully
application/json
get
GET /v1/users/{id} HTTP/1.1
Host: api.reveel.id
Authorization: Bearer JWT
Accept: */*

{
  "success": true,
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "email": "[email protected]",
    "twitterUsername": "twitter_handle",
    "walletAddress": "0x1a2b3c4d5e6f7a8b9c0d1e2f3a4b5c6d7e8f9a0b",
    "createdAt": "2023-01-15T12:00:00.000Z",
    "updatedAt": "2023-01-16T14:30:00.000Z",
    "payId": {
      "id": "123e4567-e89b-12d3-a456-426614174001",
      "name": "johndoe"
    }
  },
  "meta": {
    "message": "User retrieved successfully"
  }
}

Update a user

put

Updates information for a specific user by their ID. The user must be associated with the authenticated partner. At least one field must be provided for update.

Authorizations
Path parameters
idstring · uuidRequired

ID of the user to operate on

Body
emailstring · emailOptional

User's updated email address

Example: [email protected]
twitterUsernamestringOptional

User's updated twitter username

Example: new_twitter_handle
walletAddressstringOptional

User's updated blockchain wallet address

Example: 0x1a2b3c4d5e6f7a8b9c0d1e2f3a4b5c6d7e8f9a0b
Responses
200
User updated successfully
application/json
put
PUT /v1/users/{id} HTTP/1.1
Host: api.reveel.id
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 131

{
  "email": "[email protected]",
  "twitterUsername": "new_twitter_handle",
  "walletAddress": "0x1a2b3c4d5e6f7a8b9c0d1e2f3a4b5c6d7e8f9a0b"
}
{
  "success": true,
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "email": "[email protected]",
    "twitterUsername": "new_twitter_handle",
    "walletAddress": "0x1a2b3c4d5e6f7a8b9c0d1e2f3a4b5c6d7e8f9a0b",
    "createdAt": "2023-01-15T12:00:00.000Z",
    "updatedAt": "2023-01-16T14:30:00.000Z"
  },
  "meta": {
    "message": "User updated successfully"
  }
}

Disassociate a user

delete

Removes the association between a user and the authenticated partner. This does not delete the user from the system, only removes the association.

Authorizations
Path parameters
idstring · uuidRequired

ID of the user to operate on

Responses
200
User disassociated successfully
application/json
delete
DELETE /v1/users/{id} HTTP/1.1
Host: api.reveel.id
Authorization: Bearer JWT
Accept: */*

{
  "success": true,
  "meta": {
    "message": "User disassociated from partner successfully"
  }
}

Disconnect wallet

post

Disconnects a wallet from a specific user by setting their walletAddress to null. The user must be associated with the authenticated partner and must have a wallet connected.

Authorizations
Path parameters
idstring · uuidRequired

ID of the user to disconnect wallet from

Responses
200
Wallet disconnected successfully
application/json
post
POST /v1/users/{id}/disconnect-wallet HTTP/1.1
Host: api.reveel.id
Authorization: Bearer JWT
Accept: */*

{
  "success": true,
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "email": "[email protected]",
    "twitterUsername": "twitter_handle",
    "walletAddress": null,
    "createdAt": "2023-01-15T12:00:00.000Z",
    "updatedAt": "2023-01-16T14:30:00.000Z"
  },
  "meta": {
    "message": "Wallet disconnected successfully"
  }
}

Get a user by email

get

Retrieves a specific user by their email address. The user must exist and be associated with the authenticated partner.

Authorizations
Path parameters
emailstring · emailRequired

Email of the user to retrieve

Responses
200
User retrieved successfully
application/json
get
GET /v1/users/email/{email} HTTP/1.1
Host: api.reveel.id
Authorization: Bearer JWT
Accept: */*

{
  "success": true,
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "email": "[email protected]",
    "twitterUsername": "twitter_handle",
    "walletAddress": "0x1a2b3c4d5e6f7a8b9c0d1e2f3a4b5c6d7e8f9a0b",
    "createdAt": "2023-01-15T12:00:00.000Z",
    "updatedAt": "2023-01-16T14:30:00.000Z",
    "payId": {
      "id": "123e4567-e89b-12d3-a456-426614174001",
      "name": "johndoe"
    }
  },
  "meta": {
    "message": "User retrieved successfully"
  }
}
PreviousIntegration Best PracticesNextPayIDs

Last updated

Was this helpful?