😃Auth API
How to obtain your API keys
To obtain x-api-key please contact the team. You can find more information at the "Connect With Us" section
API-KEY
GET https://<baseURL>/api-key
Get an existing API key for a specific client
Query Parameters
| Name | Type | Description |
|---|---|---|
clientId* | string | The unique identifier of the client |
id* | string | The unique identifier of the API key |
apiKeyId* | string | The unique identifier of the API key |
Headers
| Name | Type | Description |
|---|---|---|
x-platform-password | string | A secret password for platform authentication |
POST https://<baseURL>/api-key
Create a new API key for a specific client
Request Body
| Name | Type | Description |
|---|---|---|
clientId* | string | The unique identifier of the client for whom the API key is being created |
Headers
| Name | Type | Description |
|---|---|---|
x-platform-password | string | A secret password for platform authentication |
Content-Type | string | The type of data being sent in the request body |
PUT https://<baseURL>/api-key/<apiKeyId>
Update an existing API key for a specific client
Request Body
| Name | Type | Description |
|---|---|---|
clientId* | string | The unique identifier of the client for whom the API key is being updated |
apiKey* | string | The new API key value |
Headers
| Name | Type | Description |
|---|---|---|
x-platform-password | string | A secret password for platform authentication |
Content-Type | string | The type of data being sent in the request body |
DELETE https://<baseURL>/api-key/<apiKeyId>
Delete an existing API key for a specific client
Headers
| Name | Type | Description |
|---|---|---|
x-platform-password | string | A secret password for platform authentication |
USERS
For managing users associated with a specific client, the following API endpoints are used:
POST https://<baseURL>/client-user/login
Authenticate a client user and obtain an access token for further API requests
Headers
| Name | Type | Description |
|---|---|---|
x-client-id | string | The unique identifier of the client |
Authorization | string | The access token provided by Privy Token |
GET https://<baseURL>/client-user/profile
Get the profile information of the authenticated client user
Headers
| Name | Type | Description |
|---|---|---|
x-client-id | string | The unique identifier of the client |
Authorization | string | The access token provided by Privy Token |
GET https://<baseURL>/client-user
Get a list of users associated with a specific client
Query Parameters
| Name | Type | Description |
|---|---|---|
clientId* | string | The unique identifier of the client |
Headers
| Name | Type | Description |
|---|---|---|
x-platform-password | string | A secret password for platform authentication |
These API endpoints allow you to manage the users associated with a specific client.
The POST Client User Login endpoint is used to authenticate a client user and obtain an access token, which can be used to make further API requests on behalf of that user.
The GET Client User Profile endpoint is used to retrieve the profile information of the authenticated client user.
The GET Client Users endpoint is used to retrieve a list of users associated with a specific client.
Last updated