Identity Management

Create and manage identities through the NMP.

Create Identity

💡
Creating an identity may take about 20 seconds because it is still in beta

URL

To create an identity, use /account/:accountId/identity/create.

POST - https://{{nmpUrl}}/account/:accountId/identity/create

Body

{
  "$schema":"https://cert.arianee.org/version3/ArianeeBrandIdentity-i18n.json",
  "name":"Name",
  "rpcEndpoint":"https://rpc.staging.arianee.com/rpc"
}

Return Payload

Status Code	Success	Description
`200`	`true`	The transaction is sent to the blockchain. The identity will be created.

Fetch Identity

URL

To fetch an identity, use /account/:clientId/identity/get.

POST - https://{{nmpUrl}}/account/:clientId/identity/get

Body

{
    "issuer": "0xEaB78A731989d43ea940013B4149fe93990A691C"
}

Field	Type	Required	Description
`issuer`	String	✅	Wallet address of the issuer.

Return Payload

Status Code	Success	Description
`200`	`true`	The identity is returned.

{
    "data": {
        "address": "0x57F5111A7e997a7Ba63CC8976C92decbd86C1B08",
        "imprint": "0xdfee9c6b92e2cb9a5fc6b4b394f46926510fc66db9faa694c53c61d4307cf883",
        "isApproved": true,
        "isAuthentic": true,
        "content": {
            "$schema": "https://cert.arianee.org/version2/ArianeeBrandIdentity-i18n.json",
            "name": "BDH Test",
            "companyName": "Arianee",
            "arianeeMembership": "associate_member",
            "rpcEndpoint": "https://bdh.api.staging.arianee.com/rpc"
        },
        "rawContent": {
            "$schema": "https://cert.arianee.org/version2/ArianeeBrandIdentity-i18n.json",
            "name": "BDH Test",
            "companyName": "Arianee",
            "arianeeMembership": "associate_member",
            "rpcEndpoint": "https://bdh.api.staging.arianee.com/rpc"
        },
        "protocol": {
            "name": "testnet",
            "chainId": 77
        }
    }
}

Errors

Code Status	Success	Description
`200`	`false`	The identity is not validated.

{
    "data": {
        "address": "0xEaB78A731989d43ea940013B4149fe93990A691C",
        "imprint": "0x0000000000000000000000000000000000000000000000000000000000000000",
        "isApproved": false,
        "isAuthentic": false,
        "content": {
            "$schema": "https://cert.arianee.org/version2/ArianeeBrandIdentity-i18n.json",
            "name": "/!\\ unreachable content"
        },
        "rawContent": {
            "$schema": "https://cert.arianee.org/version2/ArianeeBrandIdentity-i18n.json",
            "name": "/!\\ unreachable content"
        },
        "protocol": {
            "name": "polygon",
            "chainId": 137
        }
    }
}

Update Identity

URL

To update an identity, use /account/:accountId/identity/update.

POST - https://{{nmpUrl}}/account/:accountId/identity/update

Body

{
    "$schema":"https://cert.arianee.org/version3/ArianeeBrandIdentity-i18n.json",
    "name":"MAXIMUS 15 57",
    "rpcEndpoint":"https://bdh.rpc.staging.arianee.com/rpc"
}

Field	Type	Required	Description
`issuer`	String	✅	Wallet address of the issuer.

Return Payload

Status Code	Success	Description
`200`	`true`	The transaction is sent to the blockchain and is updated.

Updated 10 days ago