These docs are for v1.7. Click to read the latest docs for v2.1.

Check Digital Passport Claiming Status

Make sure your digital passports is claimable or claimed.

Before you begin

As a brand, you wish to allow your customers to request ownership of your digital passports. This feature allows you to check the status of your digital passports.

Use case example: Your brand wants to track the claiming status of your users who claimed digital passports following a massive drop during an event.

💡

For more information on the claim method, check out Deferred Claims!

Let's start 🚀

To verify the claiming status of the digital passport, use the deferred/verify.

📌

The API is authenticated with the user rights required → certCreate

curl --location --request POST 'https://documentation.arianee.com/deferred/verify' \
--header 'x-api-key: string' \
--header 'Content-Type: application/json' \
--data-raw '{
    "tokenId": 650923746,
    "passphrase": "etdnswn7wp37",
    "address": "0x02e07cc7E01b1ca69C0a6de55BFD9B99A8F0aF3a"
}'
ParameterTypeMandatoryDescription
tokenIdNumberDigital passport identification number.
passphraseStringDigital passport passphrase.
addressStringWallet address of the digital passport.

Results: Find below the httpCode corresponding to your API call return and its value → nmp.back.deferredTransfer.[value].

httpCodeValueDescription
200tokenCanBeTransferedThe token can be claimed by a user.
400alreadyOwnerThe user is already the owner of the token.
400tokenNotFoundIncorrect token ID.
400issuerNotOwnerYou are not the issuer of the digital passport.
400passphraseNotRightIncorrect passphrase.
400errorFetchRequestKeyThe passphrase is not a request key.
400pendingThe digital passport has been already claimed and the transfer is pending.
500errorTransferAn error occurred during the transfer.
{
    "message": "Token 494745099 will be transfered to address 0x02e07cc7E01b1ca69C0a6de55BFD9B99A8F0aF3a",
    "code": "nmp.back.deferredTransfer.success"
}
{ code: 'nmp.back.deferredTransfer.pending', description: 'Token tranfer is already pending'}