Entities

Create entity

post/api/v1/entities

Request

Base URL: /sandbox (relative, and the document was published on a file host, not at the API’s origin)
URL: /sandbox/api/v1/entities
Auth: OAuth 2 (authorization code, authorization URL https://id.efimis.com/pevolveextprod.onmicrosoft.com/b2c_1a_idp_aad_multi/oauth2/authorize, token URL https://id.efimis.com/pevolveextprod.onmicrosoft.com/b2c_1a_idp_aad_multi/oauth2/token; client credentials, token URL https://id.efimis.com/pevolveextprod.onmicrosoft.com/b2c_1a_idp_aad_multi/oauth2/token, scopes: policy.write)

idstring

e.g. entity_c0645dc026a74ae99ec436df63d77d2c

entityType0 | 1 | 2 | 3

firstNamestring nullable

Required if EntityType is Individual

middleNamesstring nullable

lastNamestring nullable

Required if EntityType is Individual

initialsstring nullable

organisationNamestring nullable

Required if EntityType is not Individual

organisationNumberstring nullable

ABN in AU, VAT number in UK

organisationNumber2string nullable

ACN in AU, optional in UK

organisationTypestring nullable

e.g. Joint Party, Company, Unlimited Liability Company

organisationContactstring nullable

The point of contact of an organisation, e.g. Office Manager, The Owner, The Secretary

preferredNamestring nullable

Nick name which the person/company prefers to be identified by colloquially. e.g. Bob

titlestring nullable

e.g. Mr Mrs Miss Dr

emailstring nullable

preferredContact0 | 1 | 2 | 3

successboolean

reasonstring nullable

resultCode0 | 100 | 101 | 102 | 103 | 104 | 105 | 106 | 107 | 108 | 109 | 110

Represents the outcome of a command execution. Used to indicate success or the reason for failure when a command does not succeed.

sourceIdstring nullable

No recorded changes to this operation across all 1 revision of this API.