Create and Manage Account¶

In order to use the services such as API or SDK, you need a Capture account. This can be acquired by registering through Capture Cam or using API with email or wallet.

With this API, developers can register for a new user account with the following payload:

{
  "username": "string",
  "email": "[email protected]",
  "password": "string"
}

Field	Description	Limitation
username	String that represents the name of the user	21 characters
email	Email of the user	Valid email address
password	Password to login	Between 8 to 32 characters

The "email" field is used to send all the sale notifications, therefore, please make sure they are correctly set during the registration.

All of these credentials are necessary in order to create an account in the Capture system and start using its services like APIs & SDKs efficiently to develop applications faster and more effectively in the Capture ecosystem.

If you do not have it yet, the easier way to create a Capture account it to download Capture Cam and register.

Reset Password¶

To reset your password, you can either download Capture Cam or use the following API to receive the email. Follow the instruction in the email to reset your password.

Endpoint: https://api.numbersprotocol.io/api/v3/auth/users/reset_password/

Method: POST

Description:
This endpoint allows you to reset the password for a specific user.

Authentication:
This endpoint does not require any authentication.

Headers:
Content-Type: application/json

Body:
email (string, required): The email address of the user you wish to reset the password for.

Success Status Code: 201

Example:
curl -X POST -H "Content-Type: application/json" \
     -d '{"email": "[email protected]"}' \
     https://api.numbersprotocol.io/api/v3/auth/users/reset_password/

Delete Account¶

To safely remove your Capture Account, you can submit a deletion request through the Capture Cam or use the provided API Endpoint.

Please be aware that once the account is deleted, all private keys associated with it will be permanently removed from the Capture backend, rendering it inaccessible. To ensure that your assets are secure, we highly recommend transferring your NUM tokens from Asset Wallet to Integrity Wallet and securely storing the private key of your Integrity Wallet.

It's also important to note that while the account deletion process will delete your files and AssetTree from the Capture backend, they will remain on the IPFS until a garbage collection event occurs.

Deleting the Capture account is an irreversible action. It is strongly recommended that you take the following precautions before proceeding:

Backup Your Integrity Wallet Private Key: Your Integrity Wallet private key is essential for accessing and managing your assets. Before deleting your Capture account, ensure you have securely backed up your private key.
Backup All Assets: Make sure to backup all assets associated with your Capture account. This includes any assets that you have stored within your account. Ensure that you have copies of everything you want to retain.
Review Your Decision: Carefully consider your decision to delete your account. Once deleted, your account and all its associated data will be permanently removed from our system. There is no way to recover a deleted account.

Endpoint: https://eoqnui40j5hnf0l.m.pipedream.net

Method: POST

Description:
This endpoint delete your account associated to the input email.

Header:

Authorization: token $YOUR_CAPTURE_TOKEN (required)
Content-Type: application/json

Body:
email (string, required): email of the Capture account as a confirmation.

Success Status Code: 200
Content: User ${email} has been deleted

Error Response
Code: 404
Content: Deletion fail, please try again later.

Example:
curl -X POST \
  https://eoqnui40j5hnf0l.m.pipedream.net \
  -H 'Authorization: token YOUR_CAPTURE_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "email": "YOUR_REGISTERED_EMAIL"
  }'

Create and Manage Account¶

Sign up¶

Reset Password¶

Delete Account¶