The Profiles API provides methods for creating and managing profiles. A profile is synonymous with a signature chain. The full supported endpoint of the profiles URI is as follows:
profiles/verb/noun/filter/operator
The minimum required components of the URI are:
profiles/verb/noun
The following verbs are currently supported by this API command-set:
create - Generate a new object of supported type.
update - Updates the specified object registers.
recover - Recovers a profile account.
status - Status information of a profile.
notifications - List all notifications that modified specified object.
transactions - List all transactions that modified specified object.
The following nouns are supported for this API command-set:
[master] - The default profile that controls all sub-profiles.
[auth] - A crypto object register for login auth.
[credentials] - Credentials used to secure profiles.
[recovery] - An object which represents recovery for the profile.
This will create a new profile or initializes the auth key for older signature chains to make them compatible with profiles, specified by the noun.
profiles/create/noun
This command only supports the master and auth nouns.
This will create a new profile specified by given noun. The profile is secured by a combination of username, password, and PIN.
This method will initialize a auth crypto object register for signature chains created with the early release of Tritium. This makes these signature chain compatible with profiles on Tritium++. Existing users may have to convert their old signature chains to be compatible to login with Tritium++ profiles if they are not able to create a session.
username : Required to create a username. The username to be associated with this profile. The profileID (used to uniquely identify profiles) is a hash of this username, therefore the username must be unique on the blockchain.
password : Required to set a password. The password to be associated with this profile.
pin : Required to set a pin. The PIN to be associated with this profile
NOTE:
username must be a minimum of 2 characters.password must be a minimum of 8 characters.PIN must be a minimum of 4 characters.{
"success": true,
"txid": "01d872456b966a14796d80f1687fe59a107fe6c3b6edd3558dce146d08f3093837136634022734d9d9b5e877311fd68f847f226ae276a12b8bc3f246513ccd08"
}
success : Boolean flag indicating that the profile was created successfully.
txid : The ID (hash) of the transaction that includes the created object.
This method provides the user with the ability to change the password, pin, or recovery seed for a profile, specified by the noun.
profiles/update/noun
This command only supports the credentials and recovery nouns.
This method provides the user with the ability to change the password, pin for this signature chain. Updating the credentials will also result in each of the keys in the sig chain's Crypto object being regenerated based on the new password / pin.
This method provides the user with the ability to set or change the restore seed for this signature chain.
session : Required by argument -multiuser=1 to be supplied to identify the user profile.
password : Required to authenticate. The existing password for this signature chain.
pin : Required if locked. The PIN to authorize the transaction.
new_password : Required by noun credentials. The new password to set for for this signature chain. This is optional if new_pin is provided
new_pin : Required by noun credentials. The new pin to set for this signature chain. This is optional if new_password is provided.
recovery : Required by noun recovery The existing recovery seed for this signature chain. This is only required if an existing recovery seed is being updated via new_recovery.
new_recovery : Required by noun recovery.The new recovery seed to set or change for this sig chain. The recovery seed must be a minimum of 40 characters.
NOTE: The recovery phrase is case-sensitive. Make sure to type in the recovery phrase correctly and not copy paste which can add spaces if not done correctly. Make sure to backup and recheck the recovery seed and create multiple offline backups.
{
"success": true,
"txid": "01947f824e9b117d618ed49a7dd84f0e7c4bb0896e40d0a95e04e27917e6ecb6b9a5ccfba7d0d5c308b684b95e98ada4f39bbac84db75e7300a09befd1ac0999"
}
[Completed in 18533.182336 ms]
success : Boolean flag indicating that the profile was updated successfully. txid : The ID (hash) of the transaction for the updated profile .
This recovers the profile specified by the noun, in case of lost password and pin. The user has to be logged out to recover his profile.
profiles/recover/noun
This command only supports the master noun.
username : Required to identify. The username identifying the profile for recovery.
password : Required to set a new password. The new password to be associated with this profile.
pin : Required to set a new pin. The new PIN to be associated with this profile.
recovery : Required to authenticate. The existing recovery seed for this profile.
{
"success": true,
"txid": "017fbb86583c0e15c0fb994a1f4c70d97f2c084533748ccfd25cd36e5aef9c2e7f89f15f2ec9f2d73769fef9d7a8a28cd018c9907ebf1bf74e4f89837c900091"
}
[Completed in 15242.801822 ms]
success : Boolean flag indicating that the profile was recovered successfully.
txid : The ID (hash) of the transaction for the recovered object.
Returns status information for the requested profile.
profiles/status/noun
This command only supports the master noun.
session : Required by argument -multiuser=1 to be supplied to identify the user profile.
{
"genesis": "b7fa11647c02a3a65a72970d8e703d8804eb127c7e7c41d565c3514a4d3fdf13",
"confirmed": true,
"recovery": true,
"crypto": true,
"transactions": 10
}
[Completed in 0.108500 ms]
genesis : This is the profile username hash, also known as owner hash.
confirmed : Boolean flag indicating whether the genesis transaction for this profile has at least one confirmation.
recovery : Flag indicating whether the recovery seed has been set for this profile.
crypto : Flag indicating whether the crypto object register has been set for this profile.
transactions : The total transaction count for this profile
This will list off all of the transactions sent to a particular signature chain. It is useful for identifying transactions that you need to accept such as credits.
profiles/notifications/noun
This command only supports the master noun.
session : Required by argument -multiuser=1 to be supplied to identify the user profile.
This method supports the Sorting / Filtering parameters.
[
{
"id": 0,
"OP": "DEBIT",
"from": "8EW4ALiZxtiRHFGqND5Yah8oYiRaXBLEHBcrovshCDLT1ZE5ENk",
"to": "8C96zrYqeyYYiRDQ9pWZkxgzMhmV7nxDUEeE8fBCufgWfJ4cnJ1",
"amount": 150.0,
"token": "8EW4ALiZxtiRHFGqND5Yah8oYiRaXBLEHBcrovshCDLT1ZE5ENk",
"ticker": "NEX",
"reference": 0,
"timestamp": 1654620671,
"txid": "012e6dc669cad475b0974308ba719bf5d69c0d7623e31399a3d83ca8e095b63ed7ac98709c08a5a15c543dd91c85c7cbb91082c355fa548435545cfb1b912a8f"
}
]
[Completed in 0.256792 ms]
id : The sequential ID of this transaction.
OP : The contract operation. Can be COINBASE, DEBIT, FEE, TRANSFER.
txid : The transaction that was credited / claimed.
suppressed: If the caller included the optional suppressed flag, then the response will include this field to indicate whether this notification is currently being suppressed or not.
from : For DEBIT transactions, the register address of the account that the debit is being made from.
from_name : For DEBIT transactions, the name of the account that the debit is being made from. Only included if the name can be resolved.
to : For DEBIT transactions, the register address of the account that the debit is being made to.
to_name : For DEBIT transactions, the name of the account that the debit is being made to. Only included if the name can be resolved.
amount : the token amount of the transaction.
token : the register address of the token that the transaction relates to. Set to 0 for NXS transactions
ticker : The name of the token that the transaction relates to.
reference : For DEBIT transactions this is the user supplied reference used by the recipient to relate the transaction to an order or invoice number.
proof : The register address of the token account proving the the split dividend debit.
dividend_payment : Flag indicating that this debit is a split dividend payment to a tokenized asset
This will list off all of the transactions for the requested profile.
profiles/transactions/noun
This command only supports the master noun.
session : Required by argument -multiuser=1 to be supplied to identify the user session that is creating the transaction.
verbose : Optional, determines how much transaction data to include in the response. Supported values are :
default : hashsummary : type, version, sequence, timestamp, operation, and confirmations.detail : genesis, nexthash, prevhash, pubkey and signature.This method supports the Sorting / Filtering parameters.
[
{
"txid": "01eb59a0c4e6c47dd2a8d3a4aa7d83514aab6f5c976207889f786e5947c0eb971065fe6e0f8fc6b7d75157f9dac0cf0c178c15e441ff360c3046c84e1fe799ca",
"type": "tritium first",
"version": 4,
"sequence": 0,
"timestamp": 1653674591,
"blockhash": "dc2712f6598a4a8c60f14c707dae4705f773fb1f60b89efd1e0163ee1d7cf823e8d73e6a3fb9f7eb73e72d7764647eb889abebc2aca34f3090dbe1409af511a301409fb8f04409bf97693dc0d908d05d9b62b949aae423196b508b3840419d1df548e72e006c75a6c69d8075693f2c8f6f7d10213a07c03bf9ff250e55a1eeef",
"confirmations": 23,
"contracts": [
{
"id": 0,
"OP": "CREATE",
"address": "89AVoe5S8gjZpVngYoYtqJbSr9fGsdsoXShxnyNaEGPvMMeDnT6",
"type": "OBJECT",
"standard": "CRYPTO",
"object": {
"app1": "0000000000000000000000000000000000000000000000000000000000000000",
"app2": "0000000000000000000000000000000000000000000000000000000000000000",
"app3": "0000000000000000000000000000000000000000000000000000000000000000",
"auth": "02b5dbda57225afab10ca271ff513beab748306cff028798e2b64505db59f252",
"cert": "0000000000000000000000000000000000000000000000000000000000000000",
"lisp": "0000000000000000000000000000000000000000000000000000000000000000",
"network": "025193caf52ce6065951a438d30696f7548e12e0ebadd60359141029c1c4d870",
"sign": "02efc8e11c7097520080718b5dd0e92267292401678fcecb317bde79df64311c",
"verify": "0000000000000000000000000000000000000000000000000000000000000000"
}
}
]
}
]
[Completed in 0.616625 ms]
txid : The transaction hash.
type : The description of the transaction (legacy | tritium base | trust | genesis | user).
version : The serialization version of the transaction.
sequence : The sequence number of this transaction within the signature chain.
timestamp : The Unix timestamp of when the transaction was created.
blockhash : The hash of the block that this transaction is included in. Blank if not yet included in a block.
confirmations : The number of confirmations that this transaction obtained by the network.
genesis : This is the profile username hash, also known as owner hash.
nexthash : The hash of the next transaction in the sequence.
prevhash : The hash of the previous transaction in the sequence.
pubkey : The public key.
signature : The signature hash.
contracts : The array of contracts bound to this transaction and their details with opcodes.
id : The sequential ID of this contract within the transaction.
OP : The contract operation. Can be APPEND, CLAIM, COINBASE, CREATE, CREDIT, DEBIT, FEE, GENESIS, LEGACY, TRANSFER, TRUST, STAKE, UNSTAKE, WRITE.
for : For CREDIT transactions, the contract that this credit was created for . Can be COINBASE, DEBIT, or LEGACY.
txid : The transaction that was credited / claimed.
contract : The ID of the contract within the transaction that was credited / claimed.
proof : The register address proving the credit.
from : For DEBIT, CREDIT, FEE transactions, the register address of the account that the debit is being made from.
from_name : For DEBIT, CREDIT, FEE transactions, the name of the account that the debit is being made from. Only included if the name can be resolved.
to : For DEBIT and CREDIT transactions, the register address of the recipient account.
to_name : For DEBIT and CREDIT transactions, the name of the recipient account. Only included if the name can be resolved.
amount : the token amount of the transaction.
token : the register address of the token that the transaction relates to. Set to 0 for NXS transactions
token_name : The name of the token that the transaction relates to.
reference : For DEBIT and CREDIT transactions this is the user supplied reference used by the recipient to relate the transaction to an order or invoice number.
object : Returns a list of all hashed public keys in the crypto object register for the specified profile. The object result will contain the nine default keys(app1, app2, app3, auth, cert, lisp, network, sign and verify).
}