LegalEntity

Retrieves the collection of LegalEntity resources.

SecurityBearer

Request

query Parameters

page	integer Default: 1 The collection page number
itemsPerPage	integer [ 0 .. 30 ] Default: 30 The number of items per page
sortBy[createdAt]	string Default: "desc" Enum: "asc" "desc"
sortBy[registeredName]	string Default: "asc" Enum: "asc" "desc"
sortBy[identifierScheme]	string Default: "asc" Enum: "asc" "desc"
sortBy[identifierValue]	string Default: "asc" Enum: "asc" "desc"
identifierValue	string
registeredName	string

Responses

200

LegalEntity collection

403

Forbidden

get/it/legal-entities

Request samples

Response samples

200
403

{"hydra:member": [{"@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": ["string"
],
"smpEnabled": true,
"createdAt": "string",
"updatedAt": "string"
}
],
"hydra:totalItems": 0,
"hydra:view": {"@id": "string",
"type": "string",
"hydra:first": "string",
"hydra:last": "string",
"hydra:previous": "string",
"hydra:next": "string"
},
"hydra:search": {"@type": "string",
"hydra:template": "string",
"hydra:variableRepresentation": "string",
"hydra:mapping": [{"@type": "string",
"variable": "string",
"property": "string",
"required": true
}
]
}
}

Creates a LegalEntity resource.

SecurityBearer

Request

Request Body schema:
application/ld+json
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/it/legal-entities

Request samples

{"registeredName": "string",
"country": "st",
"address": "string",
"city": "string",
"stateOrProvince": "string",
"zipCode": "string",
"identifierScheme": "iso6523-actorid-upis",
"identifierValue": "string",
"receivedDocumentNotificationEmails": ["string"
]
}

Response samples

201
400
403
422

{"@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": ["string"
],
"smpEnabled": true,
"createdAt": "string",
"updatedAt": "string"
}

Retrieves a LegalEntity resource.

SecurityBearer

Request

path Parameters

uuid

required

string

LegalEntity identifier

Responses

200

LegalEntity resource

403

Forbidden

404

Not found

get/it/legal-entities/{uuid}

Request samples

Response samples

200
403
404

{"@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": ["string"
],
"smpEnabled": true,
"createdAt": "string",
"updatedAt": "string"
}

Replaces the LegalEntity resource.

SecurityBearer

Request

path Parameters

uuid

required

string

LegalEntity identifier

Request Body schema:
application/ld+json
required

The updated 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

200

LegalEntity resource updated

400

Invalid input

403

Forbidden

404

Not found

422

An error occurred

put/it/legal-entities/{uuid}

Request samples

{"registeredName": "string",
"country": "st",
"address": "string",
"city": "string",
"stateOrProvince": "string",
"zipCode": "string",
"identifierScheme": "iso6523-actorid-upis",
"identifierValue": "string",
"receivedDocumentNotificationEmails": ["string"
]
}

Response samples

200
400
403
404
422

{"@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": ["string"
],
"smpEnabled": true,
"createdAt": "string",
"updatedAt": "string"
}

Removes the LegalEntity resource.

SecurityBearer

Request

path Parameters

uuid

required

string

LegalEntity identifier

Responses

204

LegalEntity resource deleted

403

Forbidden

404

Not found

delete/it/legal-entities/{uuid}

Request samples

Response samples

403
404

{"@context": "string",
"@id": "string",
"@type": "string",
"title": "string",
"detail": "string",
"status": 404,
"instance": "string",
"type": "string",
"description": "string"
}

Read SMP records

Read the SMP records for the LegalEntity resource

SecurityBearer

Request

path Parameters

uuid

required

string

LegalEntity identifier

Responses

200

LegalEntity resource

403

Forbidden

404

Not found

get/it/legal-entities/{uuid}/smp

Request samples

Response samples

200
403
404

{"@context": "string",
"@id": "string",
"@type": "string",
"enabled": true,
"capabilities": [{"@context": "string",
"@id": "string",
"@type": "string",
"documentTypeScheme": "string",
"documentType": "string",
"processScheme": "string",
"process": "string"
}
]
}

Manage SMP records

Manage the SMP records for the LegalEntity resource

SecurityBearer

Request

path Parameters

uuid

required

string

LegalEntity identifier

Request Body schema:
application/ld+json
required

The updated LegalEntity resource

enabled	boolean Setting enabled to true will write the record into the SMP, with false the record will be deleted from the SMP.
	Array of objects (LegalEntitySMPCapabilityInput.jsonld) The list of documents and processes this legal entity can manage, stored into the SMP.

Responses

200

LegalEntity resource updated

400

Invalid input

403

Forbidden

404

Not found

422

An error occurred

put/it/legal-entities/{uuid}/smp

Request samples

{"enabled": true,
"capabilities": [{"documentTypeScheme": "busdox-docid-qns",
"documentType": "string",
"processScheme": "cenbii-procid-ubl",
"process": "string"
}
]
}

Response samples

200
400
403
404
422

{"@context": "string",
"@id": "string",
"@type": "string",
"enabled": true,
"capabilities": [{"@context": "string",
"@id": "string",
"@type": "string",
"documentTypeScheme": "string",
"documentType": "string",
"processScheme": "string",
"process": "string"
}
]
}

Read Transfer Bridge options

Read the Transfer Bridge options for the LegalEntity resource

SecurityBearer

Request

path Parameters

uuid

required

string

LegalEntity identifier

Responses

200

LegalEntity resource

403

Forbidden

404

Not found

get/it/legal-entities/{uuid}/transfer-bridge

Request samples

Response samples

200
403
404

{"@context": "string",
"@id": "string",
"@type": "string",
"peppolSdiEnabled": true
}

Manage Transfer Bridge options

Manage the Transfer Bridge options for the LegalEntity resource

SecurityBearer

Request

path Parameters

uuid

required

string

LegalEntity identifier

Request Body schema:
application/ld+json
required

The updated LegalEntity resource

peppolSdiEnabled

boolean

Responses

200

LegalEntity resource updated

400

Invalid input

403

Forbidden

404

Not found

422

An error occurred

put/it/legal-entities/{uuid}/transfer-bridge

Request samples

{"peppolSdiEnabled": true
}

Response samples

200
400
403
404
422

{"@context": "string",
"@id": "string",
"@type": "string",
"peppolSdiEnabled": true
}

LegalEntity

Retrieves the collection of LegalEntity resources.

query Parameters

Creates a LegalEntity resource.

Request Body schema: application/ld+jsonapplication/jsontext/htmlapplication/xmltext/xmlapplication/pdfapplication/ld+jsonrequired

Retrieves a LegalEntity resource.

path Parameters

Replaces the LegalEntity resource.

path Parameters

Request Body schema: application/ld+jsonapplication/jsontext/htmlapplication/xmltext/xmlapplication/pdfapplication/ld+jsonrequired

Removes the LegalEntity resource.

path Parameters

Read SMP records

path Parameters

Manage SMP records

path Parameters

Request Body schema: application/ld+jsonapplication/jsontext/htmlapplication/xmltext/xmlapplication/pdfapplication/ld+jsonrequired

Read Transfer Bridge options

path Parameters

Manage Transfer Bridge options

path Parameters

Request Body schema: application/ld+jsonapplication/jsontext/htmlapplication/xmltext/xmlapplication/pdfapplication/ld+jsonrequired

Request Body schema:
application/ld+json
required

Request Body schema:
application/ld+json
required

Request Body schema:
application/ld+json
required

Request Body schema:
application/ld+json
required