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"
    }
}

Other Responses

Code

Success

Description

401

No

Unauthorized