Digital Address

API Documentation

Integrate Digital Address verification into your services.

Authentication

All API requests must be authenticated using an API key. You can generate an API key from your B2B client dashboard. Include the API key in the `Authorization` header of your requests.

Authorization: Bearer YOUR_API_KEY

Endpoints

POST
/v1/verify
Verifies a physical address and returns its corresponding Digital Address NFT ID if one exists.

Request Body

{
  "address": "1600 Amphitheatre Parkway, Mountain View, CA"
}

Response

{
  "status": "VALID",
  "nftId": "0x1A2B3c4D5e6F7a8B9c0d1E2f3A4b5C6d7E8f9A0C",
  "certaintyScore": 0.98
}
GET
/v1/lookup/{nftId}
Retrieves detailed information for a given Digital Address NFT ID, including its risk assessment.

URL Parameters

nftId (string, required): The unique identifier of the Address NFT.

Response

{
  "nftId": "0x1A2B3c4D5e6F7a8B9c0d1E2f3A4b5C6d7E8f9A0C",
  "physicalAddress": "1600 Amphitheatre Parkway, Mountain View, CA, 94043",
  "status": "Verified",
  "commercialUsage": [
    "Amazon Prime",
    "FedEx Delivery Manager"
  ],
  "riskAssessment": {
    "level": "Low",
    "findings": []
  }
}