Get Available DID

Returns a single Available DID from DIDWW inventory.

Note

Available DID request is not enabled by default. To enable this feature, please contact our Customer Service or Sales Departments.

Request

HTTP Method: GET

URI Path: /v3/available_dids/

Note

For all returned data attributes, see Available Did Object.

URI Query Parameters

Name	Type	Is Required?	Description
id	string	Yes	Unique ID number of the Available DID.
include	string	No	Inclusion

Includes

Value	Description
did_group	DID Group Object
did_group.stock_keeping_units	Stock Keeping Unit Object
nanpa_prefix	Nanpa Prefix Object

Examples

Simple requestInclude did_groupInclude did_group.stock_keeping_units

http

GET /v3/available_dids/75a21935-acfd-4160-8485-9fb7d049f144 HTTP/1.1
Host: api.didww.com
Content-Type: application/vnd.api+json
Accept: application/vnd.api+json
Api-Key: [API token]

curl

curl -i -X GET https://api.didww.com/v3/available_dids/75a21935-acfd-4160-8485-9fb7d049f144 -H "Accept: application/vnd.api+json" -H "Api-Key: [API token]" -H "Content-Type: application/vnd.api+json"

response

HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

 {
     "data": {
         "id": "75a21935-acfd-4160-8485-9fb7d049f144",
         "type": "available_dids",
         "attributes": {
             "number": "12124727604"
         },
         "relationships": {
             "did_group": {
                 "links": {
                     "self": "https://api.didww.com/v3/available_dids/75a21935-acfd-4160-8485-9fb7d049f144/relationships/did_group",
                     "related": "https://api.didww.com/v3/available_dids/75a21935-acfd-4160-8485-9fb7d049f144/did_group"
                 }
             },
             "nanpa_prefix": {
                 "links": {
                     "self": "https://api.didww.com/v3/available_dids/75a21935-acfd-4160-8485-9fb7d049f144/relationships/nanpa_prefix",
                     "related": "https://api.didww.com/v3/available_dids/75a21935-acfd-4160-8485-9fb7d049f144/nanpa_prefix"
                 }
             }
         }
     },
     "meta": {
         "api_version": "2026-04-16"
     }
 }

Other Responses

Code	Success	Description
404	No	Not Found
401	No	Unauthorized