LegalEntity

Creates a LegalEntity resource.

Creates a LegalEntity resource.

SecurityBearer
Request
Request Body schema:
required

The new LegalEntity resource

registeredName
string

Name used to register the End User in the business registry of the jurisdiction where it is legally based.

country
required
string = 2 characters

Country code ISO 3166-1 alpha-2 codes

address
string or null

Legal entity address

city
string or null

Legal entity city

stateOrProvince
string or null

Legal entity state or province

zipCode
string or null

Legal entity zip code

identifierScheme
string
Default: "iso6523-actorid-upis"

The participant identifier scheme

identifierValue
string

The participant identifier built as per the OpenPeppol normative version of the code list

receivedDocumentNotificationEmails
Array of strings or null

The list of email addresses where a notification is sent for each received document

Responses
201

LegalEntity resource created

400

Invalid input

403

Forbidden

422

An error occurred

post/legal-entities
Request samples
Response samples
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "uuid": "string",
  • "registeredName": "string",
  • "country": "string",
  • "address": "string",
  • "city": "string",
  • "stateOrProvince": "string",
  • "zipCode": "string",
  • "identifierScheme": "iso6523-actorid-upis",
  • "identifierValue": "string",
  • "receivedDocumentNotificationEmails": [
    ],
  • "smpEnabled": true,
  • "createdAt": "string",
  • "updatedAt": "string"
}