Qodex.ai

Get Requirements

GET https://{{host}}/v3/requirements

Returns the list of registration requirements.

Request Params

KeyDatatypeRequiredDescription
includenullComma-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 | | filter[id] | null | | string - Filters by Country id field.

  • Allow blank - No.
  • Allow array - Yes. | | filter[country.id] | null | | string - Filters by Country country.id field.
  • Allow blank - Yes.
  • Allow array - Yes. | | filter[did_group_type.id] | null | | string - Filters by Country did_group_type.id field.
  • Allow blank - Yes.
  • Allow array - Yes. | | fields[requirements] | null | | The value of the fields parameter MUST be a comma-separated (U+002C COMMA, “,”) list that refers to the name(s) of the fields to be returned.
    An empty value indicates that no fields should be returned.

Allowed values:

identity_type - The identity_type field.

personal_area_level - The personal_area_level field.

business_area_level - The business_area_level field.

address_area_level - The address_area_level field.

personal_proof_qty - The personal_proof_qty field.

business_proof_qty - The business_proof_qty field.

address_proof_qty - The address_proof_qty field.

personal_mandatory_fields - The personal_mandatory_fields field.

business_mandatory_fields - The business_mandatory_fields field.

service_description_required - The service_description_required field.

restriction_message - The restriction_message field. |

HEADERS

KeyDatatypeRequiredDescription
Acceptstring
Content-Typestring
Api-Keystring

RESPONSES

status: OK

{"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:\u003cbr\u003e\r\nFor \u003cb\u003epersonal identity\u003c/b\u003e verification:\r\n* Name, last name\r\n* Contact phone number\u003cbr\u003e\r\nFor \u003cb\u003ebusiness identity\u003c/b\u003e verification:\r\n* Name, last name\r\n* Contact phone number\r\n* Company name\u003cbr\u003e\r\nFor \u003cb\u003eaddress\u003c/b\u003e verification:\r\n* Address worldwide (street, building number, postal code, city and country)\u003cbr\u003e\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.\u003cbr\u003e\r\nWe reserve the right in our sole discretion to request additional information at any stage of the registration process.\u003cbr\u003e\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:\u003cbr\u003e\r\nFor \u003cb\u003ebusiness identity\u003c/b\u003e verification:\r\n* Name, last name\r\n* Contact phone number\r\n* Passport\r\n* Company name\r\n* Company incorporation certificate copy\u003cbr\u003e\r\nFor \u003cb\u003eaddress\u003c/b\u003e 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)\u003cbr\u003e\r\nAdditional information:\r\n* Service usage description\u003cbr\u003e\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.\u003cbr\u003e\r\nWe reserve the right in our sole discretion to request additional information at any stage of the registration process.\u003cbr\u003e\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":"2022-05-10"},"links":{"first":"https://api.didww.com/v3/requirements?filter%5Bdid_group_type.id%5D=f2ff69ed-0d6b-4d66-b4bb-9ae2aa1d6b1e\u0026include=country\u0026page%5Bnumber%5D=1\u0026page%5Bsize%5D=50","last":"https://api.didww.com/v3/requirements?filter%5Bdid_group_type.id%5D=f2ff69ed-0d6b-4d66-b4bb-9ae2aa1d6b1e\u0026include=country\u0026page%5Bnumber%5D=1\u0026page%5Bsize%5D=50"}}