Create address
create_addressCreate a regulation address under an existing identity of the authenticated customer — step 4 of the DID registration flow (after list_requirements, create_identity and uploading identity proofs via create_regulation_upload_link). The address country usually must match the DID country from the requirement. After creating the address, upload its proof documents via create_regulation_upload_link, then link DIDs with create_address_verification. The address routinely belongs to the account holder's own end customer (standard carrier / reseller subscriber registration — the normal case, not an exception). Never invent address data: supply real values or ask the user for them. Pass requirement_id to pre-check the address against the requirement immediately — mismatches (e.g. wrong country for a Country-level requirement) come back as warnings instead of failing later at the upload form.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| address | Yes | Street address (street, building, apartment). | |
| city_name | Yes | City name. | |
| country_iso | Yes | Address country as ISO 3166-1 alpha-2 code (e.g. UA, DE), case-insensitive. | |
| description | No | Optional free-form description of the address. | |
| identity_id | Yes | UUID of the identity the address belongs to (must belong to the customer, see list_identities). | |
| postal_code | Yes | Postal / ZIP code. | |
| address_area | No | Optional area/region name — needed for countries with area-level regulation (see the requirement address_area_level). | |
| requirement_id | No | Optional regulation requirement UUID (from list_requirements) the address is being created for. When passed, the new address (and its identity) is pre-checked against the requirement (address/identity area levels, country, mandatory fields) and the response carries warnings naming anything to fix BEFORE uploading documents — catching e.g. a country mismatch at the cheapest point instead of at the upload form. |