> For the complete documentation index, see [llms.txt](https://docs.bbchain.com.br/bbchain-ebs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.bbchain.com.br/bbchain-ebs/bbchain-ebs-pt/para-desenvolvedores/api-reference/network-management/notaries/models.md).

# Models

## The Error object

```json
{"openapi":"3.1.0","info":{"title":"EBS Notaries API","version":"0.1.0"},"components":{"schemas":{"Error":{"type":"object","properties":{"message":{"type":"string","description":"Error status summary for the executed command."},"code":{"type":"string","description":"# `network.{field}.invalid` field is non compliant # `auth.invalid` Invalid credentials sent to the server. # `auth.verifyEmail` User did not verified their email. # `auth.mustChangePassword` User must change password.         # `user.emailAlreadyUsed` Email already exists. # `auth.forbidden` Forbidden access # `internal.unexpected` Unexpected error from server ","enum":["auth.invalid","auth.verifyEmail","auth.unauthorized","auth.forbidden","auth.expired","auth.blocked","auth.emailDomainBlocked","auth.mustChangePassword","auth.invalidPhoneVerificationCode","auth.passwordNotValid","auth.unableToUpdatePassword","user.notFound","user.created","user.notCreated","user.emailAlreadyExists","userHasRoleInClient","notaryNotFound","notaryPublishDateTooEarly","notaryOrganizationNameConflict","notaryIsCreating","network.notFound","network.alias.invalid","network.name.invalid","network.domain.invalid","network.organizationLegalName.invalid","network.city.invalid","network.country.invalid","network.nodeDomain.invalid","network.tenant.invalid","networkUserDoesNotHavePermissionOnNode","networkUserDoesNotHaveOperatorPermissionOnNode","networkUserDoesNotHavePermissionOnNotary","networkUserDoesNotHaveOperatorPermissionOnNotary","node.notFound","nodeOrganizationNameConflict","cordappVersionShouldBeDisabled","cordappShouldNotHaveVersions","shouldWaitPendingFlagday","internal.unexpected","field.required","field.invalid","field.size","field.pattern","illegalStatus","badRequest","timeConstraint","reachedMaxNetworks","reachedSubscriptionLimit","userReachedSubscriptionLimit","subscriptionTenantNotFoundBecauseNetworkNotFound","subscriptionNodeNameConflict","featureDisabled","adminActionNotFound","adminActionExists","adminActionNotCreated","adminActionDuplicated","adminCloudProviderNotFound","adminCloudProviderExists","adminCloudProviderNotCreated","adminProtocolNotFound","adminProtocolExists","adminProtocolNotCreated","adminPipelineServiceNotFound","adminPipelineServiceExists","adminPipelineServiceNotCreated","adminTenantNotFound","adminTenantExists","adminTenantNotCreated","adminPipelineNotFound","adminPipelineExists","adminPipelineNotCreated","adminComponentNotFound","adminComponentExists","adminComponentNotCreated","adminTenantSettingsNotFound","adminTenantSettingsExists","adminTenantSettingsNotCreated","adminTenantProtocolNotFound","adminTenantProtocolExists","adminTenantProtocolNotCreated","adminFeatureToggleNotFound","adminFeatureToggleExists","adminUserNotFound","adminNetworkNotFound","adminNetworkExists","adminNodeNotFound","adminNodeExists","adminNotaryNotFound","adminNotaryExists","adminPipelineActionDuplicated","adminAppNotFound","adminAppVersionNotFound","adminAppInstallationNotFound","adminComponentTypeNotFound","adminComponentTypeExists","adminBaseDltNotFound","adminBaseDltExists","adminBaseDltNotCreated","adminIdentityProviderNotFound","adminIdentityProviderExists","adminIdentityProviderNotCreated","adminNodeFeatureNotFound","adminNodeFeatureExists","adminNodeFeatureNotCreated","adminSpecializedModuleNotFound","adminSpecializedModuleExists"]}}}}}}
```

## The NotaryUpdateLegalNameDTO object

```json
{"openapi":"3.1.0","info":{"title":"EBS Notaries API","version":"0.1.0"},"components":{"schemas":{"NotaryUpdateLegalNameDTO":{"type":"object","properties":{"organization":{"type":"string","maxLength":110,"minLength":2,"pattern":"^[A-Z][A-Za-z0-9]*(\\s[A-Za-z0-9]+)*$"},"city":{"type":"string","maxLength":64,"minLength":2,"pattern":"^[A-Z][A-Za-z]*(\\s[A-Za-z]+)*$"},"country":{"type":"string","maxLength":2,"minLength":2,"pattern":"^[A-Z][A-Z]$"},"publishDate":{"type":"string","format":"date-time"}},"required":["city","country","organization"]}}}}
```

## The HardwareSizeDTO object

```json
{"openapi":"3.1.0","info":{"title":"EBS Notaries API","version":"0.1.0"},"components":{"schemas":{"HardwareSizeDTO":{"type":"object","properties":{"vcpu":{"type":"number","format":"double","description":"Number of virtual cpus."},"ram":{"type":"integer","format":"int64","description":"Size of RAM."}},"required":["ram","vcpu"]}}}}
```

## The NotaryWorkerDTO object

```json
{"openapi":"3.1.0","info":{"title":"EBS Notaries API","version":"0.1.0"},"components":{"schemas":{"NotaryWorkerDTO":{"type":"object","properties":{"organization":{"type":"string","maxLength":110,"minLength":2,"pattern":"^[A-Z][A-Za-z0-9]*(\\s[A-Za-z0-9]+)*$"},"city":{"type":"string","maxLength":64,"minLength":2,"pattern":"^[A-Z][A-Za-z]*(\\s[A-Za-z]+)*$"},"country":{"type":"string","maxLength":2,"minLength":2,"pattern":"^[A-Z][A-Z]$"},"id":{"type":"integer","format":"int64","readOnly":true},"lastAccess":{"type":"string","format":"date-time","readOnly":true},"currentStatus":{"type":"string","enum":["STARTING","RUNNING","CREATING","STOPPING","STOPPED","PENDING_UPDATE","DELETING","ERROR","PURGING","RESTARTING"]},"publishDate":{"type":"string","format":"date-time"},"size":{"$ref":"#/components/schemas/HardwareSizeDTO"},"service":{"$ref":"#/components/schemas/ServiceDTO"},"validator":{"type":"boolean","description":"Corda allows for validator. However, we are opting to lock it as non-validator for now. [Read more here.](https://docs.r3.com/en/platform/corda/4.6/open-source/key-concepts-notaries.html) ","readOnly":true}},"required":["city","country","organization"]},"HardwareSizeDTO":{"type":"object","properties":{"vcpu":{"type":"number","format":"double","description":"Number of virtual cpus."},"ram":{"type":"integer","format":"int64","description":"Size of RAM."}},"required":["ram","vcpu"]},"ServiceDTO":{"type":"object","properties":{"organization":{"type":"string","maxLength":110,"minLength":2,"pattern":"^[A-Z][A-Za-z0-9]*(\\s[A-Za-z0-9]+)*$"},"city":{"type":"string","maxLength":64,"minLength":2,"pattern":"^[A-Z][A-Za-z]*(\\s[A-Za-z]+)*$"},"country":{"type":"string","maxLength":2,"minLength":2,"pattern":"^[A-Z][A-Z]$"},"id":{"type":"integer","format":"int64"}},"required":["city","country","organization"]}}}}
```

## The ServiceDTO object

```json
{"openapi":"3.1.0","info":{"title":"EBS Notaries API","version":"0.1.0"},"components":{"schemas":{"ServiceDTO":{"type":"object","properties":{"organization":{"type":"string","maxLength":110,"minLength":2,"pattern":"^[A-Z][A-Za-z0-9]*(\\s[A-Za-z0-9]+)*$"},"city":{"type":"string","maxLength":64,"minLength":2,"pattern":"^[A-Z][A-Za-z]*(\\s[A-Za-z]+)*$"},"country":{"type":"string","maxLength":2,"minLength":2,"pattern":"^[A-Z][A-Z]$"},"id":{"type":"integer","format":"int64"}},"required":["city","country","organization"]}}}}
```

## The LegalNameDTO object

```json
{"openapi":"3.1.0","info":{"title":"EBS Notaries API","version":"0.1.0"},"components":{"schemas":{"LegalNameDTO":{"type":"object","properties":{"organization":{"type":"string","maxLength":110,"minLength":2,"pattern":"^[A-Z][A-Za-z0-9]*(\\s[A-Za-z0-9]+)*$"},"city":{"type":"string","maxLength":64,"minLength":2,"pattern":"^[A-Z][A-Za-z]*(\\s[A-Za-z]+)*$"},"country":{"type":"string","maxLength":2,"minLength":2,"pattern":"^[A-Z][A-Z]$"}},"required":["city","country","organization"]}}}}
```

## The NotaryServiceDTO object

```json
{"openapi":"3.1.0","info":{"title":"EBS Notaries API","version":"0.1.0"},"components":{"schemas":{"NotaryServiceDTO":{"type":"object","properties":{"legalName":{"$ref":"#/components/schemas/LegalNameDTO"},"publishDate":{"type":"string","format":"date-time","description":"This must be in the future. At least 10 minutes in the future to give time for the service to create the components before executing the [flag day](https://docs.r3.com/en/platform/corda/1.5/cenm/updating-network-parameters.html). We adopted the same procedure for nodes only for a matter of consistency and to add some quality of life for the end-user. "},"id":{"type":"integer","format":"int64","readOnly":true},"currentStatus":{"type":"string","enum":["STARTING","RUNNING","CREATING","STOPPING","STOPPED","PENDING_UPDATE","DELETING","ERROR","PURGING","RESTARTING"]},"network":{"type":"integer","format":"int64","readOnly":true},"networkName":{"type":"string","readOnly":true},"lastAccess":{"type":"string","format":"date-time","readOnly":true},"host":{"type":"string","description":"host endpoint.","readOnly":true},"workers":{"type":"array","items":{"$ref":"#/components/schemas/WorkerDTO"},"readOnly":true},"validator":{"type":"boolean","description":"Corda allows for validator. However, we are opting to lock it as non-validator for now. [Read more here.](https://docs.r3.com/en/platform/corda/4.6/open-source/key-concepts-notaries.html) ","readOnly":true},"customer":{"type":"integer","format":"int64"},"createdBy":{"type":"integer","format":"int64","description":"ID do usuário que criou o nó","readOnly":true},"tenantId":{"type":"integer","format":"int64"}},"required":["legalName","publishDate"]},"LegalNameDTO":{"type":"object","properties":{"organization":{"type":"string","maxLength":110,"minLength":2,"pattern":"^[A-Z][A-Za-z0-9]*(\\s[A-Za-z0-9]+)*$"},"city":{"type":"string","maxLength":64,"minLength":2,"pattern":"^[A-Z][A-Za-z]*(\\s[A-Za-z]+)*$"},"country":{"type":"string","maxLength":2,"minLength":2,"pattern":"^[A-Z][A-Z]$"}},"required":["city","country","organization"]},"WorkerDTO":{"type":"object","properties":{"organization":{"type":"string","maxLength":110,"minLength":2,"pattern":"^[A-Z][A-Za-z0-9]*(\\s[A-Za-z0-9]+)*$"},"city":{"type":"string","maxLength":64,"minLength":2,"pattern":"^[A-Z][A-Za-z]*(\\s[A-Za-z]+)*$"},"country":{"type":"string","maxLength":2,"minLength":2,"pattern":"^[A-Z][A-Z]$"},"id":{"type":"integer","format":"int64","readOnly":true},"lastAccess":{"type":"string","format":"date-time","readOnly":true},"currentStatus":{"type":"string","enum":["STARTING","RUNNING","CREATING","STOPPING","STOPPED","PENDING_UPDATE","DELETING","ERROR","PURGING","RESTARTING"]},"publishDate":{"type":"string","format":"date-time"},"size":{"$ref":"#/components/schemas/HardwareSizeDTO"}},"required":["city","country","organization"]},"HardwareSizeDTO":{"type":"object","properties":{"vcpu":{"type":"number","format":"double","description":"Number of virtual cpus."},"ram":{"type":"integer","format":"int64","description":"Size of RAM."}},"required":["ram","vcpu"]}}}}
```

## The WorkerDTO object

```json
{"openapi":"3.1.0","info":{"title":"EBS Notaries API","version":"0.1.0"},"components":{"schemas":{"WorkerDTO":{"type":"object","properties":{"organization":{"type":"string","maxLength":110,"minLength":2,"pattern":"^[A-Z][A-Za-z0-9]*(\\s[A-Za-z0-9]+)*$"},"city":{"type":"string","maxLength":64,"minLength":2,"pattern":"^[A-Z][A-Za-z]*(\\s[A-Za-z]+)*$"},"country":{"type":"string","maxLength":2,"minLength":2,"pattern":"^[A-Z][A-Z]$"},"id":{"type":"integer","format":"int64","readOnly":true},"lastAccess":{"type":"string","format":"date-time","readOnly":true},"currentStatus":{"type":"string","enum":["STARTING","RUNNING","CREATING","STOPPING","STOPPED","PENDING_UPDATE","DELETING","ERROR","PURGING","RESTARTING"]},"publishDate":{"type":"string","format":"date-time"},"size":{"$ref":"#/components/schemas/HardwareSizeDTO"}},"required":["city","country","organization"]},"HardwareSizeDTO":{"type":"object","properties":{"vcpu":{"type":"number","format":"double","description":"Number of virtual cpus."},"ram":{"type":"integer","format":"int64","description":"Size of RAM."}},"required":["ram","vcpu"]}}}}
```

## The UpdateCommand object

```json
{"openapi":"3.1.0","info":{"title":"EBS Notaries API","version":"0.1.0"},"components":{"schemas":{"UpdateCommand":{"type":"object","properties":{"command":{"type":"string","enum":["STOP","START","RESTART","PURGE"]}}}}}}
```

## The UpdateDTO object

```json
{"openapi":"3.1.0","info":{"title":"EBS Notaries API","version":"0.1.0"},"components":{"schemas":{"UpdateDTO":{"type":"object","properties":{"size":{"$ref":"#/components/schemas/HardwareSizeDTO"},"command":{"type":"string","enum":["STOP","START","RESTART","PURGE"]}}},"HardwareSizeDTO":{"type":"object","properties":{"vcpu":{"type":"number","format":"double","description":"Number of virtual cpus."},"ram":{"type":"integer","format":"int64","description":"Size of RAM."}},"required":["ram","vcpu"]}}}}
```

## The NotaryServicePageDTO object

```json
{"openapi":"3.1.0","info":{"title":"EBS Notaries API","version":"0.1.0"},"components":{"schemas":{"NotaryServicePageDTO":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/NotaryServiceDTO"}},"metadata":{"$ref":"#/components/schemas/PageMetadata"}}},"NotaryServiceDTO":{"type":"object","properties":{"legalName":{"$ref":"#/components/schemas/LegalNameDTO"},"publishDate":{"type":"string","format":"date-time","description":"This must be in the future. At least 10 minutes in the future to give time for the service to create the components before executing the [flag day](https://docs.r3.com/en/platform/corda/1.5/cenm/updating-network-parameters.html). We adopted the same procedure for nodes only for a matter of consistency and to add some quality of life for the end-user. "},"id":{"type":"integer","format":"int64","readOnly":true},"currentStatus":{"type":"string","enum":["STARTING","RUNNING","CREATING","STOPPING","STOPPED","PENDING_UPDATE","DELETING","ERROR","PURGING","RESTARTING"]},"network":{"type":"integer","format":"int64","readOnly":true},"networkName":{"type":"string","readOnly":true},"lastAccess":{"type":"string","format":"date-time","readOnly":true},"host":{"type":"string","description":"host endpoint.","readOnly":true},"workers":{"type":"array","items":{"$ref":"#/components/schemas/WorkerDTO"},"readOnly":true},"validator":{"type":"boolean","description":"Corda allows for validator. However, we are opting to lock it as non-validator for now. [Read more here.](https://docs.r3.com/en/platform/corda/4.6/open-source/key-concepts-notaries.html) ","readOnly":true},"customer":{"type":"integer","format":"int64"},"createdBy":{"type":"integer","format":"int64","description":"ID do usuário que criou o nó","readOnly":true},"tenantId":{"type":"integer","format":"int64"}},"required":["legalName","publishDate"]},"LegalNameDTO":{"type":"object","properties":{"organization":{"type":"string","maxLength":110,"minLength":2,"pattern":"^[A-Z][A-Za-z0-9]*(\\s[A-Za-z0-9]+)*$"},"city":{"type":"string","maxLength":64,"minLength":2,"pattern":"^[A-Z][A-Za-z]*(\\s[A-Za-z]+)*$"},"country":{"type":"string","maxLength":2,"minLength":2,"pattern":"^[A-Z][A-Z]$"}},"required":["city","country","organization"]},"WorkerDTO":{"type":"object","properties":{"organization":{"type":"string","maxLength":110,"minLength":2,"pattern":"^[A-Z][A-Za-z0-9]*(\\s[A-Za-z0-9]+)*$"},"city":{"type":"string","maxLength":64,"minLength":2,"pattern":"^[A-Z][A-Za-z]*(\\s[A-Za-z]+)*$"},"country":{"type":"string","maxLength":2,"minLength":2,"pattern":"^[A-Z][A-Z]$"},"id":{"type":"integer","format":"int64","readOnly":true},"lastAccess":{"type":"string","format":"date-time","readOnly":true},"currentStatus":{"type":"string","enum":["STARTING","RUNNING","CREATING","STOPPING","STOPPED","PENDING_UPDATE","DELETING","ERROR","PURGING","RESTARTING"]},"publishDate":{"type":"string","format":"date-time"},"size":{"$ref":"#/components/schemas/HardwareSizeDTO"}},"required":["city","country","organization"]},"HardwareSizeDTO":{"type":"object","properties":{"vcpu":{"type":"number","format":"double","description":"Number of virtual cpus."},"ram":{"type":"integer","format":"int64","description":"Size of RAM."}},"required":["ram","vcpu"]},"PageMetadata":{"type":"object","properties":{"page":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"},"totalItems":{"type":"integer","format":"int32"},"totalPages":{"type":"integer","format":"int32"}}}}}}
```

## The PageMetadata object

```json
{"openapi":"3.1.0","info":{"title":"EBS Notaries API","version":"0.1.0"},"components":{"schemas":{"PageMetadata":{"type":"object","properties":{"page":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"},"totalItems":{"type":"integer","format":"int32"},"totalPages":{"type":"integer","format":"int32"}}}}}}
```

## The WorkersPageDTO object

```json
{"openapi":"3.1.0","info":{"title":"EBS Notaries API","version":"0.1.0"},"components":{"schemas":{"WorkersPageDTO":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/NotaryWorkerDTO"}},"metadata":{"$ref":"#/components/schemas/PageMetadata"}}},"NotaryWorkerDTO":{"type":"object","properties":{"organization":{"type":"string","maxLength":110,"minLength":2,"pattern":"^[A-Z][A-Za-z0-9]*(\\s[A-Za-z0-9]+)*$"},"city":{"type":"string","maxLength":64,"minLength":2,"pattern":"^[A-Z][A-Za-z]*(\\s[A-Za-z]+)*$"},"country":{"type":"string","maxLength":2,"minLength":2,"pattern":"^[A-Z][A-Z]$"},"id":{"type":"integer","format":"int64","readOnly":true},"lastAccess":{"type":"string","format":"date-time","readOnly":true},"currentStatus":{"type":"string","enum":["STARTING","RUNNING","CREATING","STOPPING","STOPPED","PENDING_UPDATE","DELETING","ERROR","PURGING","RESTARTING"]},"publishDate":{"type":"string","format":"date-time"},"size":{"$ref":"#/components/schemas/HardwareSizeDTO"},"service":{"$ref":"#/components/schemas/ServiceDTO"},"validator":{"type":"boolean","description":"Corda allows for validator. However, we are opting to lock it as non-validator for now. [Read more here.](https://docs.r3.com/en/platform/corda/4.6/open-source/key-concepts-notaries.html) ","readOnly":true}},"required":["city","country","organization"]},"HardwareSizeDTO":{"type":"object","properties":{"vcpu":{"type":"number","format":"double","description":"Number of virtual cpus."},"ram":{"type":"integer","format":"int64","description":"Size of RAM."}},"required":["ram","vcpu"]},"ServiceDTO":{"type":"object","properties":{"organization":{"type":"string","maxLength":110,"minLength":2,"pattern":"^[A-Z][A-Za-z0-9]*(\\s[A-Za-z0-9]+)*$"},"city":{"type":"string","maxLength":64,"minLength":2,"pattern":"^[A-Z][A-Za-z]*(\\s[A-Za-z]+)*$"},"country":{"type":"string","maxLength":2,"minLength":2,"pattern":"^[A-Z][A-Z]$"},"id":{"type":"integer","format":"int64"}},"required":["city","country","organization"]},"PageMetadata":{"type":"object","properties":{"page":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"},"totalItems":{"type":"integer","format":"int32"},"totalPages":{"type":"integer","format":"int32"}}}}}}
```

## The NotaryStatisticsDTO object

```json
{"openapi":"3.1.0","info":{"title":"EBS Notaries API","version":"0.1.0"},"components":{"schemas":{"NotaryStatisticsDTO":{"type":"object","properties":{"total":{"type":"integer","format":"int64","description":"Total number of notaries"},"protocol":{"type":"string","description":"Protocol type (all notaries are CORDA)","enum":["CORDA"]}},"required":["protocol","total"]}}}}
```