HomeDocumentationRecipesAPI ReferenceChangelog
Arianee Protocol DocumentationLog In
Documentation

Fetch Identities

Fetch Identity using Issuer Address

Fetch an identity and its associated content through the issuer's wallet address.

URL

To retrieve all information on an identity, use https://custody.arianee.com/{{client}}/{{chainType}}/identity/get.

POST - https://custody.arianee.com/{{client}}/{{chainType}}/identity/get

Body

FieldTypeRequiredDescription
issuerStringIssuer wallet address.
{
    "issuer": "0x57F5111A7e997a7Ba63CC8976C92decbd86C1B08"
}

Return Payload

Status CodeSuccessDescription
200trueThe identity is returned.
{
    "data": {
        "address": "0x57F5111A7e997a7Ba63CC8976C92decbd86C1B08",
        "imprint": "0xdfee9c6b92e2cb9a5fc6b4b394f46926510fc66db9faa694c53c61d4307cf883",
        "isApproved": true,
        "isAuthentic": true,
        "content": {
            "$schema": "https://cert.arianee.org/version2/ArianeeBrandIdentity-i18n.json",
            "name": "NMP Arianee",
            "companyName": "Arianee",
            "arianeeMembership": "associate_member",
            "rpcEndpoint": "https://nmp.arianee.com/rpc"
        },
        "rawContent": {
            "$schema": "https://cert.arianee.org/version2/ArianeeBrandIdentity-i18n.json",
            "name": "BDH STEF",
            "companyName": "Arianee",
            "arianeeMembership": "associate_member",
            "rpcEndpoint": "https://nmp.arianee.com/rpc"
        },
        "protocol": {
            "name": "testnet",
            "chainId": 77
        }
    }
}

Errors

Status CodeSuccessDescription
400falseParameters in the request may be wrong.
404falseThe wallet may not exist. You are not authenticated.
{
    "errors": [
        {
            "type": "field",
            "value": "0x57F5111A7e997a7Ba63CC8976C92decbd86C1B0",
            "msg": "issuer parameter is required and must be an ethereum address",
            "path": "issuer",
            "location": "body"
        }
    ]
}

Fetch Identities on Network

Fetch the information of validated identities owned on a given network and their associated content.

URL

To fetch identities, use https://custody.arianee.com/{{client}}/{{chainType}}/identity/getOwnedSmartAssetsIdentities.

GET - https://custody.arianee.com/{{client}}/{{chainType}}/identity/getOwnedSmartAssetsIdentities

Return Payload

Status CodeSuccessDescription
200trueThe identities and their content are returned.
[
    {
        "data": {
            "address": "0x57F5111A7e997a7Ba63CC8976C92decbd86C1B08",
            "imprint": "0xdfee9c6b92e2cb9a5fc6b4b394f46926510fc66db9faa694c53c61d4307cf883",
            "isApproved": true,
            "isAuthentic": true,
            "content": {
                "$schema": "https://cert.arianee.org/version2/ArianeeBrandIdentity-i18n.json",
                "name": "NMP Arianee",
                "companyName": "Arianee",
                "arianeeMembership": "associate_member",
                "rpcEndpoint": "https://nmp.arianee.com/rpc"
            },
            "rawContent": {
                "$schema": "https://cert.arianee.org/version2/ArianeeBrandIdentity-i18n.json",
                "name": "NMP Arianee",
                "companyName": "Arianee",
                "arianeeMembership": "associate_member",
                "rpcEndpoint": "https://nmp.arianee.com/rpc"
            },
            "protocol": {
                "name": "testnet",
                "chainId": 77
            },
            "ownedCount": 1
        }
    }
]

Error

Status CodeSuccessDescription
404falseThe wallet may not exist. You are not authenticated.