StatusLog In
API Reference and Guides

Sections

Theme switcher

/accounts/corporate

Header Parameters

idempotencystring
Max length
36
Pattern
^[a-zA-Z 0-9-_+=/]*$
Authorizationstring

Body Parameters

corporateNamestring

Legally registered name of the corporate.

corporateBusinessNamestring

Common or trading name of the corporate.

corporateRegistrationNumberstring

Registration number of the corporate based on their country of registration.

corporateRegistrationTypestring

Type of corporate registration number being supplied (for examples ABN or ACN).

Enum values:
abnacn
corporateTypestring

The type of entity the corporate is operating under. If the specific option is not present please pick the most relevant option available.

Enum values:
sole_traderlisted_companyunlisted_companypartnershipcooperativeindigenous_corporationjoint_venturetrust
countryOfRegistrationstring

Country where the corporate is registered. Denoted using 2 letter ISO standard for country codes.

Min length
2
Max length
2
phoneCountryCodestring

Country calling code for the phone number of the corporate. It needs to be prefixed with a +.

Min length
2
Max length
5
Pattern
^\+[0-9]{2,4}$
phonestring

Phone number of the corporate being registered.

Min length
3
Max length
15
physicalAddressobject

Address object representing the physical address of the corporate, not the postal address. Can use any valid combination of optional address lines.

Show child attributes

termsAndConditionsAcceptedboolean

Flag to confirm that a corporate representative has been shown and explicitly accepted Sends Terms and Conditions.

industrystring

Industry in which the corporate operates.

Enum values:
charityconsultingdesigneducationentertainmentfinancial_servicesfood_beverages_tobaccogovernmenthealth_sportsit
... 11 other enums
websitestring

Website for the corporate.

externalReferencestring

An optional value that can be passed in to later reference a related resource in the partner system.

authorisedRepresentativesarray Required

Show child attributes

Response

201
Object
Successful response.

Response Attributes

itemobject

Show child attributes

400
Object
Bad Request

Response Attributes

messagestring Required
errorsarray Required

Show child attributes

401
Object
Unauthorized

Response Attributes

messagestring
errorsarray Required

Show child attributes

409
Object
Conflict

Response Attributes

messagestring
errorsarray Required

Show child attributes

500
Object
Unknown Error

Response Attributes

messagestring
errorsarray Required

Show child attributes

Was this section helpful?

What made this section unhelpful for you?

POST

/

Select
1

Response

Was this section helpful?

What made this section unhelpful for you?