Docs API Reference Address/api/v1/address/create

postAddressPublic API v1

/api/v1/address/create

Creates a new address for the specified contact. Address is automatically validated and normalized (street names, postal codes, etc.). If country is not provided, it defaults to the organisation default country. Returns the created address object with the generated ID.

AddresspostApiV1AddressCreate

Parameters

1 query · JSON body

Query parameters

· 1

apiKeystringRequired

Your BizKitHub API key (passed as GET parameter).

Key format: A 32-character string matching: ^(PROD|DEV_|ROOT)[A-Za-z0-9]{28}$
Prefixes: PROD (production key), DEV_ (individual developer), ROOT (system key with no limits). Learn more

ExamplePRODPGrFxpGEtrOZfuWhnoJohUYBXuOE

Request body

application/json

identityIdstringRequired

Logged user identity (from your frontend cookies). Learn more

ExampleZ9CPkS2o3UV163VQn5OUv0T8BQi8Fvdg

typestringOptional

Address type code. Common values: delivery, billing, contact, invoice.

Examplesdeliverybillingcontact

firstNamestringOptional

First name of the person.

lastNamestringOptional

Last name of the person.

companyNamestringOptional

Company name (for business addresses).

streetAddressstringOptional

Street name and house number.

postalCodestringOptional

Postal/ZIP code.

citystringOptional

City name.

cityPartstringOptional

City district or part.

stateRegionstringOptional

State or region name.

countrystringOptional

ISO 3166-1 alpha-2 country code.

ExamplesCZSKUS

companyRegistrationNumberstringOptional

Company registration number (IČO in CZ).

taxIdentificationNumberstringOptional

Tax identification number (DIČ in CZ, VAT ID in EU).

noticestringOptional

Additional notes or delivery instructions.

Response schema

1 status code documented

200Success

idstringRequired

Address external identifier (core__address.external_id).

Example6IU2SWgP76FO2UXw