Manage Proof of Ownership

Generate Proof of Ownership

As a brand, you wish to allow your users to prove their digital passport ownership. Our API generates a link to read the digital passport content and prove this user owns it.

URL

Use the https://custody.arianee.com/{{client}}/{{chainType}}/nft/createProofLink.

POST - https://custody.arianee.com/{{client}}/{{chainType}}/nft/createProofLink

Body

Field	Type	Required	Description
`protocolName`	String - `testnet`, `mainnet`, `arianeetestnet`, `mumbai`, `polygon`, `arialabs`, `stadetoulousain`, `ysl`, `testnetSbt`, `arianeeSupernet`, `arianeesbt`, `supernettestnet`	✅	Protocol on which the digital passport has been minted. Dig deeper into Arianee Protocols.
`smartAsset` → `id`	Object - {id: string}	✅	Digital passport identification number.
params	Object - {passphrase:string}	❌	Auto generated field

{
    "protocolName": "testnet",
    "smartAsset" : {
        "id": "33491174"
    }
}

Return Payload

Status Code	Success	Description
`200`	`true`	The `proofLink` is generated.

{
    "proofLink": "https://test.arian.ee/proof/33491174,ss9t4d2yg1yl"
}

Error

Status Code	Success	Description
`403`	`false`	You are not the owner or issuer of this digital passport.
`404`	`false`	The wallet may not exist. You are not authenticated.
`404`	`false`	No digital passport was found using this ID.

Check Proof of Ownership

URL

Use the https://custody.arianee.com/{{client}}/{{chainType}}/nft/checkProofLink.

POST - https://custody.arianee.com/{{client}}/{{chainType}}/nft/checkProofLink

Body

Field	Type	Required	Description
`protocolName`	String - `testnet`, `mainnet`, `arianeetestnet`, `mumbai`, `polygon`, `arialabs`, `stadetoulousain`, `ysl`, `testnetSbt`, `arianeeSupernet`, `arianeesbt`, `supernettestnet`	✅	Protocol on which the digital passport has been minted. Dig deeper into Arianee Protocols.
`smartAsset` → `id`	Object	✅	Digital passport identification number.

{
    "link": "https://test.arian.ee/proof/33491174,ss9t4d2yg1yl"
}

Return Payload

Status Code	Success	Description
`200`	`true`	The `proofLink` is checked and `true` is returned when the `proofLink` is valid.

{
    "valid": true,
    "message": "Proof link is valid!",
    "link": "https://test.arian.ee/proof/33491174,ss9t4d2yg1yl"
}

Error

Status Code	Success	Description
`404`	`false`	The wallet may not exist. You are not authenticated.