Users

Create a new user

post

https://api.reveel.id/v1https://staging-api.reveel.id/v1

/users

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

bearerAuth

AuthorizationstringRequired

API keys are provided when a partner account is created and can be regenerated if needed. To authenticate requests, include your API key in the request headers using the Bearer token format: Authorization: Bearer your-api-key

Required Permissions

The following permissions are required for the User endpoints:

• user:create - Create new users and associate them with your partner account
• user:read - View users associated with your partner account
• user:update - Modify user information for users associated with your partner account
• user:delete - Disassociate users from your partner account

Body

application/json

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

400

Invalid request data

application/json

401

Authentication failed

application/json

409

User already associated with partner

application/json

500

Server error

application/json

post

/users

HTTPcURLJavaScriptPython

POST /v1/users HTTP/1.1
Host: api.reveel.id
Authorization: Bearer YOUR_SECRET_TOKEN
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

https://api.reveel.id/v1https://staging-api.reveel.id/v1

/users/{id}

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

Authorizations

bearerAuth

AuthorizationstringRequired

API keys are provided when a partner account is created and can be regenerated if needed. To authenticate requests, include your API key in the request headers using the Bearer token format: Authorization: Bearer your-api-key

Required Permissions

The following permissions are required for the User endpoints:

• user:create - Create new users and associate them with your partner account
• user:read - View users associated with your partner account
• user:update - Modify user information for users associated with your partner account
• user:delete - Disassociate users from your partner account

Path parameters

idstring · uuidRequired

ID of the user to operate on

Responses

200

User retrieved successfully

application/json

401

Authentication failed

application/json

404

User not found

application/json

500

Server error

application/json

get

/users/{id}

HTTPcURLJavaScriptPython

GET /v1/users/{id} HTTP/1.1
Host: api.reveel.id
Authorization: Bearer YOUR_SECRET_TOKEN
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

https://api.reveel.id/v1https://staging-api.reveel.id/v1

/users/{id}

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

bearerAuth

AuthorizationstringRequired

API keys are provided when a partner account is created and can be regenerated if needed. To authenticate requests, include your API key in the request headers using the Bearer token format: Authorization: Bearer your-api-key

Required Permissions

The following permissions are required for the User endpoints:

• user:create - Create new users and associate them with your partner account
• user:read - View users associated with your partner account
• user:update - Modify user information for users associated with your partner account
• user:delete - Disassociate users from your partner account

Path parameters

idstring · uuidRequired

ID of the user to operate on

Body

application/json

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

400

Invalid request data

application/json

401

Authentication failed

application/json

404

User not found

application/json

409

Email already in use

application/json

500

Server error

application/json

put

/users/{id}

HTTPcURLJavaScriptPython

PUT /v1/users/{id} HTTP/1.1
Host: api.reveel.id
Authorization: Bearer YOUR_SECRET_TOKEN
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

https://api.reveel.id/v1https://staging-api.reveel.id/v1

/users/{id}

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

Authorizations

bearerAuth

AuthorizationstringRequired

API keys are provided when a partner account is created and can be regenerated if needed. To authenticate requests, include your API key in the request headers using the Bearer token format: Authorization: Bearer your-api-key

Required Permissions

The following permissions are required for the User endpoints:

• user:create - Create new users and associate them with your partner account
• user:read - View users associated with your partner account
• user:update - Modify user information for users associated with your partner account
• user:delete - Disassociate users from your partner account

Path parameters

idstring · uuidRequired

ID of the user to operate on

Responses

200

User disassociated successfully

application/json

401

Authentication failed

application/json

404

Association not found

application/json

500

Server error

application/json

delete

/users/{id}

HTTPcURLJavaScriptPython

DELETE /v1/users/{id} HTTP/1.1
Host: api.reveel.id
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

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

Disconnect wallet

post

https://api.reveel.id/v1https://staging-api.reveel.id/v1

/users/{id}/disconnect-wallet

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

bearerAuth

AuthorizationstringRequired

API keys are provided when a partner account is created and can be regenerated if needed. To authenticate requests, include your API key in the request headers using the Bearer token format: Authorization: Bearer your-api-key

Required Permissions

The following permissions are required for the User endpoints:

• user:create - Create new users and associate them with your partner account
• user:read - View users associated with your partner account
• user:update - Modify user information for users associated with your partner account
• user:delete - Disassociate users from your partner account

Path parameters

idstring · uuidRequired

ID of the user to disconnect wallet from

Responses

200

Wallet disconnected successfully

application/json

400

No wallet connected

application/json

401

Authentication failed

application/json

404

User not found

application/json

500

Server error

application/json

post

/users/{id}/disconnect-wallet

HTTPcURLJavaScriptPython

POST /v1/users/{id}/disconnect-wallet HTTP/1.1
Host: api.reveel.id
Authorization: Bearer YOUR_SECRET_TOKEN
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

https://api.reveel.id/v1https://staging-api.reveel.id/v1

/users/email/{email}

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

Authorizations

bearerAuth

AuthorizationstringRequired

API keys are provided when a partner account is created and can be regenerated if needed. To authenticate requests, include your API key in the request headers using the Bearer token format: Authorization: Bearer your-api-key

Required Permissions

The following permissions are required for the User endpoints:

• user:create - Create new users and associate them with your partner account
• user:read - View users associated with your partner account
• user:update - Modify user information for users associated with your partner account
• user:delete - Disassociate users from your partner account

Path parameters

emailstring · emailRequired

Email of the user to retrieve

Responses

200

User retrieved successfully

application/json

401

Authentication failed

application/json

404

User not found

application/json

500

Server error

application/json

get

/users/email/{email}

HTTPcURLJavaScriptPython

GET /v1/users/email/{email} HTTP/1.1
Host: api.reveel.id
Authorization: Bearer YOUR_SECRET_TOKEN
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"
  }
}