Declare Product as Lost or Stolen

A user has lost or got stolen his product, so statut of the associated digital passport must be updated as such.

🛠️

The lost & stolen feature works on the basis of the certificateId, our teams are working to provide this functionality with the productId in the near future.

💡

• If you set a digital passport as stolen, the missing status is automatically set as true.
• If you unset a digital passport stolen status, the missing status is not automatically set as false.

Let's start 🚀

Fetch if a digital passport is declared missing

URL

To know if a digital passport is declared as missing, use the /lostAndStolen/isMissing.

URL

POST - https://{{nmpUrl}}/lostAndStolen/isMissing

Body

Field	Type	Required	Description
certificateId	String	✅	Identification number of the digital passport.

Body example

{
    "certificateId":"70260619"
}

Return Payload

Status Code	Description
200	The digital passport missing status is returned: true: The digital passport status is set as missing. false: The digital passport status is not set as missing.

200 Return Payload

{
    "isMissing": true
}

Errors

Status Code	Success	Error Message
400	false	Wrong certificateId.

400 Return Payload

{
    "errors": [
        {
            "msg": "certificateId must be a string or a number",
            "param": "certificateId",
            "location": "body"
        }
    ]
}

---

Fetch if a digital passport is declared stolen

URL

To know if a digital passport is declared as missing, use the /lostAndStolen/isStolen.

URL

POST - https://{{nmpUrl}}/lostAndStolen/isStolen

Body

Field	Type	Required	Description
certificateId	String	✅	Identification number of the digital passport.

Body example

{
    "certificateId":"43868083"
}

Return Payload

Status Code	Description
200	The digital passport's stolen status is returned: true: The digital passport status is set as stolen. false: The digital passport status is not set as stolen.

200 Return Payload

{
    "isStolen": false
}

Errors

Status Code	Success	Error Message
400	false	Wrong certificateId.

400 Return Payload

{
    "errors": [
        {
            "msg": "certificateId must be a string or a number",
            "param": "certificateId",
            "location": "body"
        }
    ]
}

---

Set or unset a passport missing status

URL

To set/unset a digital passport as missing, use the /lostAndStolen/setMissing.

URL

POST - https://{{nmpUrl}}/lostAndStolen/setMissing

Body

Field	Type	Required	Description
certificateId	String	✅	Identification number of the digital passport.
isMissing	Boolean	✅	true: Set the status as missing. false: Unset the missing status.

Body example

{
    "certificateId":"43868083",
    "isMissing":true
}

Return Payload

Status Code	Description
200	The digital passport ID and status are returned.

200 Return Payload

{
    "smartAssetId": "43868083",
    "missingStatus": true
}

Errors

Status Code	Success	Error Message
500	false	The target digital passport status is already set as missing.
500	false	Your NFT Management Platform is not the issuer of the target digital passport, you are not authorized to modify the status.

500 Return Payload

{
    "error": "Error while executing the protocol v1 action Missing status is already set as true"
}

500 Return Payload

{
    "error": "You are not the issuer of this smart asset"
}

---

Set or unset passport stolen status

URL

To set/unset a digital passport as missing, use the /lostAndStolen/setStolen.

URL

POST - https://{{nmpUrl}}/lostAndStolen/setStolen

Body

Field	Type	Required	Description
certificateId	String	✅	Identification number of the digital passport.
isStolen	Boolean	✅	true: Set the status as stolen. false: Unset the stolen status.

Body example

{
    "certificateId":"43868083",
    "isStolen":true
}

Return Payload

Status Code	Description
200	The digital passport ID and status are returned.

200 Return Payload

{
    "smartAssetId": "43868083",
    "stolenStatus": true
}

Errors

Status Code	Success	Error Message
500	false	The target digital passport status is already set as stolen.
500	false	Your NFT Management Platform is not the issuer of the target digital passport, you are not authorized to modify the status.
500	false	A server error may occur.

500 Return Payload

{
    "error": "Error while executing the protocol v1 action Stolen status is already set as true"
}

500 Return Payload

{
    "error": "You are not the issuer of this smart asset"
}