Get Requirement

Description

Returns the registration requirements per single country.

Request

HTTP Method: GET

URI Path: /v3/requirements/

URI Query Parameters:

Name

Type

Is Required?

Description

include

string

Optional

Includes

Includes

Value

Description

countries

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

Example

http

GET /v3/requirements/d210e6e4-1716-4342-b04c-7a6ef6feb171 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/d210e6e4-1716-4342-b04c-7a6ef6feb171 -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": "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": {
        "api_version": "2021-12-15"
    }
}

Other Responses

Code

Success

Description

401

No

Unauthorized