User Endpoints

User Endpoints

🚧

Important

Don't forget to include your tokenAPI and cryptKey in the request.

Ex.: https://secure.d4sign.com.br/api/v1/safes?tokenAPI={YOUR-TOKEN}&cryptKey={YOUR-CRYPT-KEY}

List All Users

GET /users/list

Test Endpoint 🧪

This method lists all users within your domain. To use it, you must have a validated domain.

📘

The response returns 500 users per page.

Use the pg parameter in the URL to paginate the results.
Example: Ex.: https://secure.d4sign.com.br/api/v1/users/list?tokenAPI={YOUR-TOKEN}&cryptKey={crypt-key}&pg=2

The first response block will display the total number of pages available.

{
    "Content-Type": "application/json"
}

{
    "nome": "User's name",
    "email": "[email protected]",
    "status": "1",
    "apenas_cofre_compartilhado": "0"
}

Check User

POST/users/check

Test Endpoint 🧪

This method checks the status of a user within your domain. You must have a validated domain to use it.

{
    "Content-Type": "application/json"
}

{
    "email_user":"[email protected]"
}

{
    "user": "[email protected]",
    "status": "unblocked"
}

Block User

POST/users/block

Test Endpoint 🧪

This method will block a user within your domain. You must have a validated domain to use this endpoint.

{
    "Content-Type": "application/json"
}

{
    "email_user": "[email protected]"
}

{
    "message": "User [email protected] was blocked",
    "success": "1"
}

Unblock User

POST/users/unblock

Test Endpoint 🧪

This method will unblock a user within your domain. You must have a validated domain to use this endpoint.

{
    "Content-Type": "application/json"
}

{
    "email_user":"[email protected]"
}

{
    "message": ""User [email protected] was unblocked"",
    "success": "1"
}