Get Requirements

Description

Returns the list of registration requirements.

Request

HTTP Method: GET

URI Path: /v3/requirements

URI Query Parameters:

Name	Type	Is Required?	Description
filter[<filter_name>]	`string`	Optional	Filtering
sort	`string`	Optional	Sorting
include	`string`	Optional	Includes

Includes

Value	Description
country	Country Object
did_group_type	DID Group Type Object
personal_permanent_document	Supporting Document Template Object
business_permanent_document	Supporting Document Template Object
personal_onetime_document	Supporting Document Template Object
business_onetime_document	Supporting Document Template Object
personal_proof_types	Proof Type Object
business_proof_types	Proof Type Object
address_proof_types	Proof Type Object

Filters:

Filter Name	Type	Allow Blank	Allow Array	Filters by:
id	`string`	No	Yes	Country `id` field.
country.id	`string`	Yes	Yes	Country `name` field.
did_group_type.id	`string`	Yes	Yes	Country `prefix` field.

Fielding:

Value	Returns:
identity_type	The `identity_type` attribute.
personal_area_level	The `personal_area_level` attribute.
business_area_level	The `business_area_level` attribute.
address_area_level	The `address_area_level` attribute.
personal_proof_qty	The `personal_proof_qty` attribute.
business_proof_qty	The `business_proof_qty` attribute.
address_proof_qty	The `business_proof_qty` attribute.
personal_mandatory_fields	The `personal_mandatory_fields` attribute.
business_mandatory_fields	The `business_mandatory_fields` attribute.
service_description_required	The `service_description_required` attribute.
restriction_message	The `restriction_message` attribute.

Example

http

GET /v3/requirements 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/requirements -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": "3f3be6a6-a513-4509-bd9b-945e599e16f5",
            "type": "requirements",
            "attributes": {
                "identity_type": "Any",
                "personal_area_level": "WorldWide",
                "business_area_level": "WorldWide",
                "address_area_level": "Area",
                "personal_proof_qty": 0,
                "business_proof_qty": 0,
                "address_proof_qty": 0,
                "personal_mandatory_fields": null,
                "business_mandatory_fields": null,
                "service_description_required": true,
                "restriction_message": "Restriction message"
            },
            "relationships": {
                "country": {
                    "links": {
                        "self": "https://sandbox-api.didww.com/v3/requirements/3f3be6a6-a513-4509-bd9b-945e599e16f5/relationships/country",
                        "related": "https://sandbox-api.didww.com/v3/requirements/3f3be6a6-a513-4509-bd9b-945e599e16f5/country"
                    }
                },
                "did_group_type": {
                    "links": {
                        "self": "https://sandbox-api.didww.com/v3/requirements/3f3be6a6-a513-4509-bd9b-945e599e16f5/relationships/did_group_type",
                        "related": "https://sandbox-api.didww.com/v3/requirements/3f3be6a6-a513-4509-bd9b-945e599e16f5/did_group_type"
                    }
                },
                "personal_permanent_document": {
                    "links": {
                        "self": "https://sandbox-api.didww.com/v3/requirements/3f3be6a6-a513-4509-bd9b-945e599e16f5/relationships/personal_permanent_document",
                        "related": "https://sandbox-api.didww.com/v3/requirements/3f3be6a6-a513-4509-bd9b-945e599e16f5/personal_permanent_document"
                    }
                },
                "business_permanent_document": {
                    "links": {
                        "self": "https://sandbox-api.didww.com/v3/requirements/3f3be6a6-a513-4509-bd9b-945e599e16f5/relationships/business_permanent_document",
                        "related": "https://sandbox-api.didww.com/v3/requirements/3f3be6a6-a513-4509-bd9b-945e599e16f5/business_permanent_document"
                    }
                },
                "personal_onetime_document": {
                    "links": {
                        "self": "https://sandbox-api.didww.com/v3/requirements/3f3be6a6-a513-4509-bd9b-945e599e16f5/relationships/personal_onetime_document",
                        "related": "https://sandbox-api.didww.com/v3/requirements/3f3be6a6-a513-4509-bd9b-945e599e16f5/personal_onetime_document"
                    }
                },
                "business_onetime_document": {
                    "links": {
                        "self": "https://sandbox-api.didww.com/v3/requirements/3f3be6a6-a513-4509-bd9b-945e599e16f5/relationships/business_onetime_document",
                        "related": "https://sandbox-api.didww.com/v3/requirements/3f3be6a6-a513-4509-bd9b-945e599e16f5/business_onetime_document"
                    }
                },
                "personal_proof_types": {
                    "links": {
                        "self": "https://sandbox-api.didww.com/v3/requirements/3f3be6a6-a513-4509-bd9b-945e599e16f5/relationships/personal_proof_types",
                        "related": "https://sandbox-api.didww.com/v3/requirements/3f3be6a6-a513-4509-bd9b-945e599e16f5/personal_proof_types"
                    }
                },
                "business_proof_types": {
                    "links": {
                        "self": "https://sandbox-api.didww.com/v3/requirements/3f3be6a6-a513-4509-bd9b-945e599e16f5/relationships/business_proof_types",
                        "related": "https://sandbox-api.didww.com/v3/requirements/3f3be6a6-a513-4509-bd9b-945e599e16f5/business_proof_types"
                    }
                },
                "address_proof_types": {
                    "links": {
                        "self": "https://sandbox-api.didww.com/v3/requirements/3f3be6a6-a513-4509-bd9b-945e599e16f5/relationships/address_proof_types",
                        "related": "https://sandbox-api.didww.com/v3/requirements/3f3be6a6-a513-4509-bd9b-945e599e16f5/address_proof_types"
                    }
                }
            }
        },
        {
            "id": "d210e6e4-1716-4342-b04c-7a6ef6feb171",
            "type": "requirements",
            "attributes": {
                "identity_type": "Business",
                "personal_area_level": null,
                "business_area_level": "WorldWide",
                "address_area_level": "Area",
                "personal_proof_qty": 0,
                "business_proof_qty": 1,
                "address_proof_qty": 1,
                "personal_mandatory_fields": null,
                "business_mandatory_fields": null,
                "service_description_required": true,
                "restriction_message": "Ireland Local DID registration requirements:\r\n\r\n1. Name, business name and contact phone number.\r\n2. Current address in Ireland, must be from the same area in Ireland as DID ordered (street, building number, postal code, city).\r\n\r\nDID number will not be activated until full registration details are provided and approved."
            },
            "relationships": {
                "country": {
                    "links": {
                        "self": "https://sandbox-api.didww.com/v3/requirements/d210e6e4-1716-4342-b04c-7a6ef6feb171/relationships/country",
                        "related": "https://sandbox-api.didww.com/v3/requirements/d210e6e4-1716-4342-b04c-7a6ef6feb171/country"
                    }
                },
                "did_group_type": {
                    "links": {
                        "self": "https://sandbox-api.didww.com/v3/requirements/d210e6e4-1716-4342-b04c-7a6ef6feb171/relationships/did_group_type",
                        "related": "https://sandbox-api.didww.com/v3/requirements/d210e6e4-1716-4342-b04c-7a6ef6feb171/did_group_type"
                    }
                },
                "personal_permanent_document": {
                    "links": {
                        "self": "https://sandbox-api.didww.com/v3/requirements/d210e6e4-1716-4342-b04c-7a6ef6feb171/relationships/personal_permanent_document",
                        "related": "https://sandbox-api.didww.com/v3/requirements/d210e6e4-1716-4342-b04c-7a6ef6feb171/personal_permanent_document"
                    }
                },
                "business_permanent_document": {
                    "links": {
                        "self": "https://sandbox-api.didww.com/v3/requirements/d210e6e4-1716-4342-b04c-7a6ef6feb171/relationships/business_permanent_document",
                        "related": "https://sandbox-api.didww.com/v3/requirements/d210e6e4-1716-4342-b04c-7a6ef6feb171/business_permanent_document"
                    }
                },
                "personal_onetime_document": {
                    "links": {
                        "self": "https://sandbox-api.didww.com/v3/requirements/d210e6e4-1716-4342-b04c-7a6ef6feb171/relationships/personal_onetime_document",
                        "related": "https://sandbox-api.didww.com/v3/requirements/d210e6e4-1716-4342-b04c-7a6ef6feb171/personal_onetime_document"
                    }
                },
                "business_onetime_document": {
                    "links": {
                        "self": "https://sandbox-api.didww.com/v3/requirements/d210e6e4-1716-4342-b04c-7a6ef6feb171/relationships/business_onetime_document",
                        "related": "https://sandbox-api.didww.com/v3/requirements/d210e6e4-1716-4342-b04c-7a6ef6feb171/business_onetime_document"
                    }
                },
                "personal_proof_types": {
                    "links": {
                        "self": "https://sandbox-api.didww.com/v3/requirements/d210e6e4-1716-4342-b04c-7a6ef6feb171/relationships/personal_proof_types",
                        "related": "https://sandbox-api.didww.com/v3/requirements/d210e6e4-1716-4342-b04c-7a6ef6feb171/personal_proof_types"
                    }
                },
                "business_proof_types": {
                    "links": {
                        "self": "https://sandbox-api.didww.com/v3/requirements/d210e6e4-1716-4342-b04c-7a6ef6feb171/relationships/business_proof_types",
                        "related": "https://sandbox-api.didww.com/v3/requirements/d210e6e4-1716-4342-b04c-7a6ef6feb171/business_proof_types"
                    }
                },
                "address_proof_types": {
                    "links": {
                        "self": "https://sandbox-api.didww.com/v3/requirements/d210e6e4-1716-4342-b04c-7a6ef6feb171/relationships/address_proof_types",
                        "related": "https://sandbox-api.didww.com/v3/requirements/d210e6e4-1716-4342-b04c-7a6ef6feb171/address_proof_types"
                    }
                }
            }
        }
    ],
    "meta": {
        "total_records": 2,
        "api_version": "2021-12-15"
    },
    "links": {
        "first": "https://sandbox-api.didww.com/v3/requirements?page%5Bnumber%5D=1&page%5Bsize%5D=50",
        "last": "https://sandbox-api.didww.com/v3/requirements?page%5Bnumber%5D=1&page%5Bsize%5D=50"
    }
}

http

GET /v3/requirements?filter%5Bcountry.id%5D=38003e8b-cccc-41d4-b1a6-d1e6fddf2c0f 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/requirements?filter%5Bcountry.id%5D=38003e8b-cccc-41d4-b1a6-d1e6fddf2c0f' -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": "3553253a-99eb-4303-a16a-6b1042d3f147",
         "type": "requirements",
         "attributes":          {
            "identity_type": "Any",
            "personal_area_level": "WorldWide",
            "business_area_level": "Country",
            "address_area_level": "Country",
            "personal_proof_qty": 1,
            "business_proof_qty": 1,
            "address_proof_qty": 1,
            "personal_mandatory_fields": null,
            "business_mandatory_fields": ["country"],
            "service_description_required": false,
            "restriction_message": "German National DID End User registration requirements:<br>\r\nFor <b>personal identity<\/b> verification:\r\n* Name, last name\r\n* Contact phone number\r\n* Passport or ID copy\r\n* Germany registration form<br>\r\nFor <b>business identity<\/b> verification:\r\n* Name, last name\r\n* Contact phone number\r\n* Company name\r\n* German company incorporation certificate copy\r\n* Germany registration form<br>\r\nFor <b>address<\/b> verification:\r\n* Address in Germany (street, building number, postal code, city and country)\r\n* A copy of a utility bill (less than 6 months old)<br>\r\nThe number provided online is a <b>demo<\/b>. An active number will be provided when the registration process is complete.<br>\r\nTo activate the DID number(s) please create an identity and address bundle matching the requirements and assign it to the DID number(s) for approval.<br>\r\nWe reserve the right in our sole discretion to request additional information at any stage of the registration process.<br>\r\n"
         },
         "relationships":          {
            "country": {"links":             {
               "self": "https://api.didww.com/v3/requirements/3553253a-99eb-4303-a16a-6b1042d3f147/relationships/country",
               "related": "https://api.didww.com/v3/requirements/3553253a-99eb-4303-a16a-6b1042d3f147/country"
            }},
            "did_group_type": {"links":             {
               "self": "https://api.didww.com/v3/requirements/3553253a-99eb-4303-a16a-6b1042d3f147/relationships/did_group_type",
               "related": "https://api.didww.com/v3/requirements/3553253a-99eb-4303-a16a-6b1042d3f147/did_group_type"
            }},
            "personal_permanent_document": {"links":             {
               "self": "https://api.didww.com/v3/requirements/3553253a-99eb-4303-a16a-6b1042d3f147/relationships/personal_permanent_document",
               "related": "https://api.didww.com/v3/requirements/3553253a-99eb-4303-a16a-6b1042d3f147/personal_permanent_document"
            }},
            "business_permanent_document": {"links":             {
               "self": "https://api.didww.com/v3/requirements/3553253a-99eb-4303-a16a-6b1042d3f147/relationships/business_permanent_document",
               "related": "https://api.didww.com/v3/requirements/3553253a-99eb-4303-a16a-6b1042d3f147/business_permanent_document"
            }},
            "personal_onetime_document": {"links":             {
               "self": "https://api.didww.com/v3/requirements/3553253a-99eb-4303-a16a-6b1042d3f147/relationships/personal_onetime_document",
               "related": "https://api.didww.com/v3/requirements/3553253a-99eb-4303-a16a-6b1042d3f147/personal_onetime_document"
            }},
            "business_onetime_document": {"links":             {
               "self": "https://api.didww.com/v3/requirements/3553253a-99eb-4303-a16a-6b1042d3f147/relationships/business_onetime_document",
               "related": "https://api.didww.com/v3/requirements/3553253a-99eb-4303-a16a-6b1042d3f147/business_onetime_document"
            }},
            "personal_proof_types": {"links":             {
               "self": "https://api.didww.com/v3/requirements/3553253a-99eb-4303-a16a-6b1042d3f147/relationships/personal_proof_types",
               "related": "https://api.didww.com/v3/requirements/3553253a-99eb-4303-a16a-6b1042d3f147/personal_proof_types"
            }},
            "business_proof_types": {"links":             {
               "self": "https://api.didww.com/v3/requirements/3553253a-99eb-4303-a16a-6b1042d3f147/relationships/business_proof_types",
               "related": "https://api.didww.com/v3/requirements/3553253a-99eb-4303-a16a-6b1042d3f147/business_proof_types"
            }},
            "address_proof_types": {"links":             {
               "self": "https://api.didww.com/v3/requirements/3553253a-99eb-4303-a16a-6b1042d3f147/relationships/address_proof_types",
               "related": "https://api.didww.com/v3/requirements/3553253a-99eb-4303-a16a-6b1042d3f147/address_proof_types"
            }}
         }
      },
            {
         "id": "229310cf-21c1-41f0-9cfb-c4ea133304d5",
         "type": "requirements",
         "attributes":          {
            "identity_type": "Any",
            "personal_area_level": "WorldWide",
            "business_area_level": "Country",
            "address_area_level": "City",
            "personal_proof_qty": 1,
            "business_proof_qty": 1,
            "address_proof_qty": 1,
            "personal_mandatory_fields": null,
            "business_mandatory_fields": ["country"],
            "service_description_required": false,
            "restriction_message": "German Local DID End User registration requirements:<br>\r\nFor <b>personal identity<\/b> verification:\r\n* Name, last name\r\n* Contact phone number\r\n* Passport or ID copy\r\n* Germany registration form<br>\r\nFor <b>business identity<\/b> verification:\r\n* Name, last name\r\n* Contact phone number\r\n* Company name\r\n* German company incorporation certificate copy\r\n* Germany registration form<br>\r\nFor <b>address<\/b> verification:\r\n* Address matching the DID area code (street, building number, postal code, city and country)\r\n* A copy of a utility bill (less than 6 months old)<br>\r\nThe number provided online is a <b>demo<\/b>. An active number will be provided when the registration process is complete.<br>\r\nTo activate the DID number(s) please create an identity and address bundle matching the requirements and assign it to the DID number(s) for approval.<br>\r\nWe reserve the right in our sole discretion to request additional information at any stage of the registration process.<br>\r\n"
         },
         "relationships":          {
            "country": {"links":             {
               "self": "https://api.didww.com/v3/requirements/229310cf-21c1-41f0-9cfb-c4ea133304d5/relationships/country",
               "related": "https://api.didww.com/v3/requirements/229310cf-21c1-41f0-9cfb-c4ea133304d5/country"
            }},
            "did_group_type": {"links":             {
               "self": "https://api.didww.com/v3/requirements/229310cf-21c1-41f0-9cfb-c4ea133304d5/relationships/did_group_type",
               "related": "https://api.didww.com/v3/requirements/229310cf-21c1-41f0-9cfb-c4ea133304d5/did_group_type"
            }},
            "personal_permanent_document": {"links":             {
               "self": "https://api.didww.com/v3/requirements/229310cf-21c1-41f0-9cfb-c4ea133304d5/relationships/personal_permanent_document",
               "related": "https://api.didww.com/v3/requirements/229310cf-21c1-41f0-9cfb-c4ea133304d5/personal_permanent_document"
            }},
            "business_permanent_document": {"links":             {
               "self": "https://api.didww.com/v3/requirements/229310cf-21c1-41f0-9cfb-c4ea133304d5/relationships/business_permanent_document",
               "related": "https://api.didww.com/v3/requirements/229310cf-21c1-41f0-9cfb-c4ea133304d5/business_permanent_document"
            }},
            "personal_onetime_document": {"links":             {
               "self": "https://api.didww.com/v3/requirements/229310cf-21c1-41f0-9cfb-c4ea133304d5/relationships/personal_onetime_document",
               "related": "https://api.didww.com/v3/requirements/229310cf-21c1-41f0-9cfb-c4ea133304d5/personal_onetime_document"
            }},
            "business_onetime_document": {"links":             {
               "self": "https://api.didww.com/v3/requirements/229310cf-21c1-41f0-9cfb-c4ea133304d5/relationships/business_onetime_document",
               "related": "https://api.didww.com/v3/requirements/229310cf-21c1-41f0-9cfb-c4ea133304d5/business_onetime_document"
            }},
            "personal_proof_types": {"links":             {
               "self": "https://api.didww.com/v3/requirements/229310cf-21c1-41f0-9cfb-c4ea133304d5/relationships/personal_proof_types",
               "related": "https://api.didww.com/v3/requirements/229310cf-21c1-41f0-9cfb-c4ea133304d5/personal_proof_types"
            }},
            "business_proof_types": {"links":             {
               "self": "https://api.didww.com/v3/requirements/229310cf-21c1-41f0-9cfb-c4ea133304d5/relationships/business_proof_types",
               "related": "https://api.didww.com/v3/requirements/229310cf-21c1-41f0-9cfb-c4ea133304d5/business_proof_types"
            }},
            "address_proof_types": {"links":             {
               "self": "https://api.didww.com/v3/requirements/229310cf-21c1-41f0-9cfb-c4ea133304d5/relationships/address_proof_types",
               "related": "https://api.didww.com/v3/requirements/229310cf-21c1-41f0-9cfb-c4ea133304d5/address_proof_types"
            }}
         }
      }
   ],
   "meta":    {
      "total_records": 2,
      "api_version": "2021-12-15"
   },
   "links":    {
      "first": "https://api.didww.com/v3/requirements?filter%5Bcountry.id%5D=38003e8b-cccc-41d4-b1a6-d1e6fddf2c0f&page%5Bnumber%5D=1&page%5Bsize%5D=50",
      "last": "https://api.didww.com/v3/requirements?filter%5Bcountry.id%5D=38003e8b-cccc-41d4-b1a6-d1e6fddf2c0f&page%5Bnumber%5D=1&page%5Bsize%5D=50"
   }
}

http

GET /v3/requirements?filter%5Bdid_group_type.id%5D=f2ff69ed-0d6b-4d66-b4bb-9ae2aa1d6b1e 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/requirements?filter%5Bdid_group_type.id%5D=f2ff69ed-0d6b-4d66-b4bb-9ae2aa1d6b1e' -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": "5558cecd-cf91-4189-ad77-0f21518eb0d9",
         "type": "requirements",
         "attributes":          {
            "identity_type": "Any",
            "personal_area_level": "WorldWide",
            "business_area_level": "WorldWide",
            "address_area_level": "WorldWide",
            "personal_proof_qty": 0,
            "business_proof_qty": 0,
            "address_proof_qty": 0,
            "personal_mandatory_fields": null,
            "business_mandatory_fields": null,
            "service_description_required": false,
            "restriction_message": "Australian Shared Cost DID End User registration requirements:<br>\r\nFor <b>personal identity<\/b> verification:\r\n* Name, last name\r\n* Contact phone number<br>\r\nFor <b>business identity<\/b> verification:\r\n* Name, last name\r\n* Contact phone number\r\n* Company name<br>\r\nFor <b>address<\/b> verification:\r\n* Address worldwide (street, building number, postal code, city and country)<br>\r\nTo activate the DID number(s) please create an identity and address bundle matching the requirements and assign it to the DID number(s) for approval.<br>\r\nWe reserve the right in our sole discretion to request additional information at any stage of the registration process.<br>\r\n"
         },
         "relationships":          {
            "country": {"links":             {
               "self": "https://api.didww.com/v3/requirements/5558cecd-cf91-4189-ad77-0f21518eb0d9/relationships/country",
               "related": "https://api.didww.com/v3/requirements/5558cecd-cf91-4189-ad77-0f21518eb0d9/country"
            }},
            "did_group_type": {"links":             {
               "self": "https://api.didww.com/v3/requirements/5558cecd-cf91-4189-ad77-0f21518eb0d9/relationships/did_group_type",
               "related": "https://api.didww.com/v3/requirements/5558cecd-cf91-4189-ad77-0f21518eb0d9/did_group_type"
            }},
            "personal_permanent_document": {"links":             {
               "self": "https://api.didww.com/v3/requirements/5558cecd-cf91-4189-ad77-0f21518eb0d9/relationships/personal_permanent_document",
               "related": "https://api.didww.com/v3/requirements/5558cecd-cf91-4189-ad77-0f21518eb0d9/personal_permanent_document"
            }},
            "business_permanent_document": {"links":             {
               "self": "https://api.didww.com/v3/requirements/5558cecd-cf91-4189-ad77-0f21518eb0d9/relationships/business_permanent_document",
               "related": "https://api.didww.com/v3/requirements/5558cecd-cf91-4189-ad77-0f21518eb0d9/business_permanent_document"
            }},
            "personal_onetime_document": {"links":             {
               "self": "https://api.didww.com/v3/requirements/5558cecd-cf91-4189-ad77-0f21518eb0d9/relationships/personal_onetime_document",
               "related": "https://api.didww.com/v3/requirements/5558cecd-cf91-4189-ad77-0f21518eb0d9/personal_onetime_document"
            }},
            "business_onetime_document": {"links":             {
               "self": "https://api.didww.com/v3/requirements/5558cecd-cf91-4189-ad77-0f21518eb0d9/relationships/business_onetime_document",
               "related": "https://api.didww.com/v3/requirements/5558cecd-cf91-4189-ad77-0f21518eb0d9/business_onetime_document"
            }},
            "personal_proof_types": {"links":             {
               "self": "https://api.didww.com/v3/requirements/5558cecd-cf91-4189-ad77-0f21518eb0d9/relationships/personal_proof_types",
               "related": "https://api.didww.com/v3/requirements/5558cecd-cf91-4189-ad77-0f21518eb0d9/personal_proof_types"
            }},
            "business_proof_types": {"links":             {
               "self": "https://api.didww.com/v3/requirements/5558cecd-cf91-4189-ad77-0f21518eb0d9/relationships/business_proof_types",
               "related": "https://api.didww.com/v3/requirements/5558cecd-cf91-4189-ad77-0f21518eb0d9/business_proof_types"
            }},
            "address_proof_types": {"links":             {
               "self": "https://api.didww.com/v3/requirements/5558cecd-cf91-4189-ad77-0f21518eb0d9/relationships/address_proof_types",
               "related": "https://api.didww.com/v3/requirements/5558cecd-cf91-4189-ad77-0f21518eb0d9/address_proof_types"
            }}
         }
      },
            {
         "id": "469d5cb4-baf6-4639-a500-f3bd04e89861",
         "type": "requirements",
         "attributes":          {
            "identity_type": "Business",
            "personal_area_level": null,
            "business_area_level": "WorldWide",
            "address_area_level": "WorldWide",
            "personal_proof_qty": 0,
            "business_proof_qty": 2,
            "address_proof_qty": 2,
            "personal_mandatory_fields": null,
            "business_mandatory_fields": ["id_number"],
            "service_description_required": true,
            "restriction_message": "Chinese Shared Cost DID End User registration requirements:<br>\r\nFor <b>business identity<\/b> verification:\r\n* Name, last name\r\n* Contact phone number\r\n* Passport\r\n* Company name\r\n* Company incorporation certificate copy<br>\r\nFor <b>address<\/b> verification:\r\n* Address worldwide (street, building number, postal code, city and country)\r\n* 2 copies of utility bills (less than 6 months old)<br>\r\nAdditional information:\r\n* Service usage description<br>\r\nTo activate the DID number(s) please create an identity and address bundle matching the requirements and assign it to the DID number(s) for approval.<br>\r\nWe reserve the right in our sole discretion to request additional information at any stage of the registration process.<br>\r\n"
         },
         "relationships":          {
            "country": {"links":             {
               "self": "https://api.didww.com/v3/requirements/469d5cb4-baf6-4639-a500-f3bd04e89861/relationships/country",
               "related": "https://api.didww.com/v3/requirements/469d5cb4-baf6-4639-a500-f3bd04e89861/country"
            }},
            "did_group_type": {"links":             {
               "self": "https://api.didww.com/v3/requirements/469d5cb4-baf6-4639-a500-f3bd04e89861/relationships/did_group_type",
               "related": "https://api.didww.com/v3/requirements/469d5cb4-baf6-4639-a500-f3bd04e89861/did_group_type"
            }},
            "personal_permanent_document": {"links":             {
               "self": "https://api.didww.com/v3/requirements/469d5cb4-baf6-4639-a500-f3bd04e89861/relationships/personal_permanent_document",
               "related": "https://api.didww.com/v3/requirements/469d5cb4-baf6-4639-a500-f3bd04e89861/personal_permanent_document"
            }},
            "business_permanent_document": {"links":             {
               "self": "https://api.didww.com/v3/requirements/469d5cb4-baf6-4639-a500-f3bd04e89861/relationships/business_permanent_document",
               "related": "https://api.didww.com/v3/requirements/469d5cb4-baf6-4639-a500-f3bd04e89861/business_permanent_document"
            }},
            "personal_onetime_document": {"links":             {
               "self": "https://api.didww.com/v3/requirements/469d5cb4-baf6-4639-a500-f3bd04e89861/relationships/personal_onetime_document",
               "related": "https://api.didww.com/v3/requirements/469d5cb4-baf6-4639-a500-f3bd04e89861/personal_onetime_document"
            }},
            "business_onetime_document": {"links":             {
               "self": "https://api.didww.com/v3/requirements/469d5cb4-baf6-4639-a500-f3bd04e89861/relationships/business_onetime_document",
               "related": "https://api.didww.com/v3/requirements/469d5cb4-baf6-4639-a500-f3bd04e89861/business_onetime_document"
            }},
            "personal_proof_types": {"links":             {
               "self": "https://api.didww.com/v3/requirements/469d5cb4-baf6-4639-a500-f3bd04e89861/relationships/personal_proof_types",
               "related": "https://api.didww.com/v3/requirements/469d5cb4-baf6-4639-a500-f3bd04e89861/personal_proof_types"
            }},
            "business_proof_types": {"links":             {
               "self": "https://api.didww.com/v3/requirements/469d5cb4-baf6-4639-a500-f3bd04e89861/relationships/business_proof_types",
               "related": "https://api.didww.com/v3/requirements/469d5cb4-baf6-4639-a500-f3bd04e89861/business_proof_types"
            }},
            "address_proof_types": {"links":             {
               "self": "https://api.didww.com/v3/requirements/469d5cb4-baf6-4639-a500-f3bd04e89861/relationships/address_proof_types",
               "related": "https://api.didww.com/v3/requirements/469d5cb4-baf6-4639-a500-f3bd04e89861/address_proof_types"
            }}
         }
      }
   ],
   "meta":    {
      "total_records": 2,
      "api_version": "2021-12-15"
   },
   "links":    {
      "first": "https://api.didww.com/v3/requirements?filter%5Bdid_group_type.id%5D=f2ff69ed-0d6b-4d66-b4bb-9ae2aa1d6b1e&page%5Bnumber%5D=1&page%5Bsize%5D=50",
      "last": "https://api.didww.com/v3/requirements?filter%5Bdid_group_type.id%5D=f2ff69ed-0d6b-4d66-b4bb-9ae2aa1d6b1e&page%5Bnumber%5D=1&page%5Bsize%5D=50"
   }
}

http

GET /v3/requirements?filter%5Bdid_group_type.id%5D=f2ff69ed-0d6b-4d66-b4bb-9ae2aa1d6b1e&include=country 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/requirements?filter%5Bdid_group_type.id%5D=f2ff69ed-0d6b-4d66-b4bb-9ae2aa1d6b1e&include=country' -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": "5558cecd-cf91-4189-ad77-0f21518eb0d9",
         "type": "requirements",
         "attributes":          {
            "identity_type": "Any",
            "personal_area_level": "WorldWide",
            "business_area_level": "WorldWide",
            "address_area_level": "WorldWide",
            "personal_proof_qty": 0,
            "business_proof_qty": 0,
            "address_proof_qty": 0,
            "personal_mandatory_fields": null,
            "business_mandatory_fields": null,
            "service_description_required": false,
            "restriction_message": "Australian Shared Cost DID End User registration requirements:<br>\r\nFor <b>personal identity<\/b> verification:\r\n* Name, last name\r\n* Contact phone number<br>\r\nFor <b>business identity<\/b> verification:\r\n* Name, last name\r\n* Contact phone number\r\n* Company name<br>\r\nFor <b>address<\/b> verification:\r\n* Address worldwide (street, building number, postal code, city and country)<br>\r\nTo activate the DID number(s) please create an identity and address bundle matching the requirements and assign it to the DID number(s) for approval.<br>\r\nWe reserve the right in our sole discretion to request additional information at any stage of the registration process.<br>\r\n"
         },
         "relationships":          {
            "country":             {
               "links":                {
                  "self": "https://api.didww.com/v3/requirements/5558cecd-cf91-4189-ad77-0f21518eb0d9/relationships/country",
                  "related": "https://api.didww.com/v3/requirements/5558cecd-cf91-4189-ad77-0f21518eb0d9/country"
               },
               "data":                {
                  "type": "countries",
                  "id": "afeb1a21-abb4-4983-8712-7ab44950fc16"
               }
            },
            "did_group_type": {"links":             {
               "self": "https://api.didww.com/v3/requirements/5558cecd-cf91-4189-ad77-0f21518eb0d9/relationships/did_group_type",
               "related": "https://api.didww.com/v3/requirements/5558cecd-cf91-4189-ad77-0f21518eb0d9/did_group_type"
            }},
            "personal_permanent_document": {"links":             {
               "self": "https://api.didww.com/v3/requirements/5558cecd-cf91-4189-ad77-0f21518eb0d9/relationships/personal_permanent_document",
               "related": "https://api.didww.com/v3/requirements/5558cecd-cf91-4189-ad77-0f21518eb0d9/personal_permanent_document"
            }},
            "business_permanent_document": {"links":             {
               "self": "https://api.didww.com/v3/requirements/5558cecd-cf91-4189-ad77-0f21518eb0d9/relationships/business_permanent_document",
               "related": "https://api.didww.com/v3/requirements/5558cecd-cf91-4189-ad77-0f21518eb0d9/business_permanent_document"
            }},
            "personal_onetime_document": {"links":             {
               "self": "https://api.didww.com/v3/requirements/5558cecd-cf91-4189-ad77-0f21518eb0d9/relationships/personal_onetime_document",
               "related": "https://api.didww.com/v3/requirements/5558cecd-cf91-4189-ad77-0f21518eb0d9/personal_onetime_document"
            }},
            "business_onetime_document": {"links":             {
               "self": "https://api.didww.com/v3/requirements/5558cecd-cf91-4189-ad77-0f21518eb0d9/relationships/business_onetime_document",
               "related": "https://api.didww.com/v3/requirements/5558cecd-cf91-4189-ad77-0f21518eb0d9/business_onetime_document"
            }},
            "personal_proof_types": {"links":             {
               "self": "https://api.didww.com/v3/requirements/5558cecd-cf91-4189-ad77-0f21518eb0d9/relationships/personal_proof_types",
               "related": "https://api.didww.com/v3/requirements/5558cecd-cf91-4189-ad77-0f21518eb0d9/personal_proof_types"
            }},
            "business_proof_types": {"links":             {
               "self": "https://api.didww.com/v3/requirements/5558cecd-cf91-4189-ad77-0f21518eb0d9/relationships/business_proof_types",
               "related": "https://api.didww.com/v3/requirements/5558cecd-cf91-4189-ad77-0f21518eb0d9/business_proof_types"
            }},
            "address_proof_types": {"links":             {
               "self": "https://api.didww.com/v3/requirements/5558cecd-cf91-4189-ad77-0f21518eb0d9/relationships/address_proof_types",
               "related": "https://api.didww.com/v3/requirements/5558cecd-cf91-4189-ad77-0f21518eb0d9/address_proof_types"
            }}
         }
      },
            {
         "id": "469d5cb4-baf6-4639-a500-f3bd04e89861",
         "type": "requirements",
         "attributes":          {
            "identity_type": "Business",
            "personal_area_level": null,
            "business_area_level": "WorldWide",
            "address_area_level": "WorldWide",
            "personal_proof_qty": 0,
            "business_proof_qty": 2,
            "address_proof_qty": 2,
            "personal_mandatory_fields": null,
            "business_mandatory_fields": ["id_number"],
            "service_description_required": true,
            "restriction_message": "Chinese Shared Cost DID End User registration requirements:<br>\r\nFor <b>business identity<\/b> verification:\r\n* Name, last name\r\n* Contact phone number\r\n* Passport\r\n* Company name\r\n* Company incorporation certificate copy<br>\r\nFor <b>address<\/b> verification:\r\n* Address worldwide (street, building number, postal code, city and country)\r\n* 2 copies of utility bills (less than 6 months old)<br>\r\nAdditional information:\r\n* Service usage description<br>\r\nTo activate the DID number(s) please create an identity and address bundle matching the requirements and assign it to the DID number(s) for approval.<br>\r\nWe reserve the right in our sole discretion to request additional information at any stage of the registration process.<br>\r\n"
         },
         "relationships":          {
            "country":             {
               "links":                {
                  "self": "https://api.didww.com/v3/requirements/469d5cb4-baf6-4639-a500-f3bd04e89861/relationships/country",
                  "related": "https://api.didww.com/v3/requirements/469d5cb4-baf6-4639-a500-f3bd04e89861/country"
               },
               "data":                {
                  "type": "countries",
                  "id": "7006e60d-d2c7-4479-94ad-b954038e6dde"
               }
            },
            "did_group_type": {"links":             {
               "self": "https://api.didww.com/v3/requirements/469d5cb4-baf6-4639-a500-f3bd04e89861/relationships/did_group_type",
               "related": "https://api.didww.com/v3/requirements/469d5cb4-baf6-4639-a500-f3bd04e89861/did_group_type"
            }},
            "personal_permanent_document": {"links":             {
               "self": "https://api.didww.com/v3/requirements/469d5cb4-baf6-4639-a500-f3bd04e89861/relationships/personal_permanent_document",
               "related": "https://api.didww.com/v3/requirements/469d5cb4-baf6-4639-a500-f3bd04e89861/personal_permanent_document"
            }},
            "business_permanent_document": {"links":             {
               "self": "https://api.didww.com/v3/requirements/469d5cb4-baf6-4639-a500-f3bd04e89861/relationships/business_permanent_document",
               "related": "https://api.didww.com/v3/requirements/469d5cb4-baf6-4639-a500-f3bd04e89861/business_permanent_document"
            }},
            "personal_onetime_document": {"links":             {
               "self": "https://api.didww.com/v3/requirements/469d5cb4-baf6-4639-a500-f3bd04e89861/relationships/personal_onetime_document",
               "related": "https://api.didww.com/v3/requirements/469d5cb4-baf6-4639-a500-f3bd04e89861/personal_onetime_document"
            }},
            "business_onetime_document": {"links":             {
               "self": "https://api.didww.com/v3/requirements/469d5cb4-baf6-4639-a500-f3bd04e89861/relationships/business_onetime_document",
               "related": "https://api.didww.com/v3/requirements/469d5cb4-baf6-4639-a500-f3bd04e89861/business_onetime_document"
            }},
            "personal_proof_types": {"links":             {
               "self": "https://api.didww.com/v3/requirements/469d5cb4-baf6-4639-a500-f3bd04e89861/relationships/personal_proof_types",
               "related": "https://api.didww.com/v3/requirements/469d5cb4-baf6-4639-a500-f3bd04e89861/personal_proof_types"
            }},
            "business_proof_types": {"links":             {
               "self": "https://api.didww.com/v3/requirements/469d5cb4-baf6-4639-a500-f3bd04e89861/relationships/business_proof_types",
               "related": "https://api.didww.com/v3/requirements/469d5cb4-baf6-4639-a500-f3bd04e89861/business_proof_types"
            }},
            "address_proof_types": {"links":             {
               "self": "https://api.didww.com/v3/requirements/469d5cb4-baf6-4639-a500-f3bd04e89861/relationships/address_proof_types",
               "related": "https://api.didww.com/v3/requirements/469d5cb4-baf6-4639-a500-f3bd04e89861/address_proof_types"
            }}
         }
      }
   ],
   "included":    [
            {
         "id": "afeb1a21-abb4-4983-8712-7ab44950fc16",
         "type": "countries",
         "attributes":          {
            "name": "Australia",
            "prefix": "61",
            "iso": "AU"
         },
         "relationships": {"regions": {"links":          {
            "self": "https://api.didww.com/v3/countries/afeb1a21-abb4-4983-8712-7ab44950fc16/relationships/regions",
            "related": "https://api.didww.com/v3/countries/afeb1a21-abb4-4983-8712-7ab44950fc16/regions"
         }}}
      },
            {
         "id": "7006e60d-d2c7-4479-94ad-b954038e6dde",
         "type": "countries",
         "attributes":          {
            "name": "China",
            "prefix": "86",
            "iso": "CN"
         },
         "relationships": {"regions": {"links":          {
            "self": "https://api.didww.com/v3/countries/7006e60d-d2c7-4479-94ad-b954038e6dde/relationships/regions",
            "related": "https://api.didww.com/v3/countries/7006e60d-d2c7-4479-94ad-b954038e6dde/regions"
         }}}
      }
   ],
   "meta":    {
      "total_records": 2,
      "api_version": "2021-12-15"
   },
   "links":    {
      "first": "https://api.didww.com/v3/requirements?filter%5Bdid_group_type.id%5D=f2ff69ed-0d6b-4d66-b4bb-9ae2aa1d6b1e&include=country&page%5Bnumber%5D=1&page%5Bsize%5D=50",
      "last": "https://api.didww.com/v3/requirements?filter%5Bdid_group_type.id%5D=f2ff69ed-0d6b-4d66-b4bb-9ae2aa1d6b1e&include=country&page%5Bnumber%5D=1&page%5Bsize%5D=50"
   }
}

Other Responses

Code	Success	Description
401	No	Unauthorized