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.

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

Use case

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

Let's start 🚀

URL

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

POST - https://{{nmpUrl}}/deferred/verify

📌
The API is authenticated with the user rights required → certCreate

Body

Field	Type	Required	Description
`tokenId`	Number	✅	Digital passport identification number.
`passphrase`	String	✅	Digital passport passphrase.
`address`	String	✅	Wallet address of the digital passport.

{
    "tokenId": 494745099,
    "passphrase": "dblkxrkmf51u",
    "address": "0x02e07cc7E01b1ca69C0a6de55BFD9B99A8F0aF3b"
}

Return Payload

Field	Type	Description
`success`	Boolean	Indicates whether the request was successful.
`data`	Object	Contains the full payload and blockchain information ???

{
    "message": "Token can be transfered to address 0x02e07cc7E01b1ca69C0a6de55BFD9B99A8F0aF3a",
    "code": "nmp.back.deferredTransfer.tokenCanBeTransfered"
}

Errors

Status Code	Code	Description
`400`	`nmp.back.deferredTransfer.alreadyOwner`	The user is already the owner of the token.
`400`	`nmp.back.deferredTransfer.tokenNotFound`	Incorrect token ID.
`400`	`nmp.back.deferredTransfer.issuerNotOwner`	You are not the issuer of the digital passport.
`400`	`nmp.back.deferredTransfer.passphraseNotRight`	Incorrect passphrase.
`400`	`nmp.back.deferredTransfer.errorFetchRequestKey`	The passphrase is not a request key.
`400`	`nmp.back.deferredTransfer.pending`	Token already claimed and transfer is already pending.
`500`	`nmp.back.deferredTransfer.errorTransfer`	An error occurred during the transfer.

{
    "name": "API Error",
    "description": "You are already the owner",
    "code": "nmp.back.deferredTransfer.alreadyOwner",
    "httpCode": 400
}

{ 
  code: 'nmp.back.deferredTransfer.pending', 
  description: 'Token tranfer is already pending'
}

Updated about 1 year ago