Get Requirement
GET https://{{host}}/v3/requirements/:id
Returns the registration requirements per single country.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
include | null | Comma-separated values of include parameter. | |
The response will include a top-level object relationships with associated data under the appropriate resource key. | |||
| Details in Inclusion of Related Resources Article. |
Allowed values:
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 |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string | ||
Content-Type | string | ||
Api-Key | string |
RESPONSES
status: OK
{"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://api.didww.com/v3/requirements/d210e6e4-1716-4342-b04c-7a6ef6feb171/relationships/country","related":"https://api.didww.com/v3/requirements/d210e6e4-1716-4342-b04c-7a6ef6feb171/country"}},"did_group_type":{"links":{"self":"https://api.didww.com/v3/requirements/d210e6e4-1716-4342-b04c-7a6ef6feb171/relationships/did_group_type","related":"https://api.didww.com/v3/requirements/d210e6e4-1716-4342-b04c-7a6ef6feb171/did_group_type"}},"personal_permanent_document":{"links":{"self":"https://api.didww.com/v3/requirements/d210e6e4-1716-4342-b04c-7a6ef6feb171/relationships/personal_permanent_document","related":"https://api.didww.com/v3/requirements/d210e6e4-1716-4342-b04c-7a6ef6feb171/personal_permanent_document"}},"business_permanent_document":{"links":{"self":"https://api.didww.com/v3/requirements/d210e6e4-1716-4342-b04c-7a6ef6feb171/relationships/business_permanent_document","related":"https://api.didww.com/v3/requirements/d210e6e4-1716-4342-b04c-7a6ef6feb171/business_permanent_document"}},"personal_onetime_document":{"links":{"self":"https://api.didww.com/v3/requirements/d210e6e4-1716-4342-b04c-7a6ef6feb171/relationships/personal_onetime_document","related":"https://api.didww.com/v3/requirements/d210e6e4-1716-4342-b04c-7a6ef6feb171/personal_onetime_document"}},"business_onetime_document":{"links":{"self":"https://api.didww.com/v3/requirements/d210e6e4-1716-4342-b04c-7a6ef6feb171/relationships/business_onetime_document","related":"https://api.didww.com/v3/requirements/d210e6e4-1716-4342-b04c-7a6ef6feb171/business_onetime_document"}},"personal_proof_types":{"links":{"self":"https://api.didww.com/v3/requirements/d210e6e4-1716-4342-b04c-7a6ef6feb171/relationships/personal_proof_types","related":"https://api.didww.com/v3/requirements/d210e6e4-1716-4342-b04c-7a6ef6feb171/personal_proof_types"}},"business_proof_types":{"links":{"self":"https://api.didww.com/v3/requirements/d210e6e4-1716-4342-b04c-7a6ef6feb171/relationships/business_proof_types","related":"https://api.didww.com/v3/requirements/d210e6e4-1716-4342-b04c-7a6ef6feb171/business_proof_types"}},"address_proof_types":{"links":{"self":"https://api.didww.com/v3/requirements/d210e6e4-1716-4342-b04c-7a6ef6feb171/relationships/address_proof_types","related":"https://api.didww.com/v3/requirements/d210e6e4-1716-4342-b04c-7a6ef6feb171/address_proof_types"}}}},"meta":{"api_version":"2021-12-15"}}